com.esri.arcgis.controls
Interface IEngineInkGenericDrawTool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ControlsInkGenericDrawTool, IEngineInkGenericDrawToolProxy

public interface IEngineInkGenericDrawTool

extends java.io.Serializable

Provides access to the ink properties of the ControlsInkGenericDrawTool.

Product Availability

Available with ArcGIS Engine.

Description

The IEngineInkGenericDrawTool interface controls the properties of the ControlsInkGenericDrawTool.

Method Summary

int	getColor() The color used to render the element created by this tool.
int	getTipType() The pen tip type used to render the element created by this tool.
int	getTransparency() The transparency used to render the element created by this tool.
int	getWidth() The width (in mm) used to render the element created by this tool.
void	setColor(int pColor) The color used to render the element created by this tool.
void	setTipType(int pTipType) The pen tip type used to render the element created by this tool.
void	setTransparency(int pTrans) The transparency used to render the element created by this tool.
void	setWidth(int pWidth) The width (in mm) used to render the element created by this tool.

Method Detail

setColor

public void setColor(int pColor)
              throws java.io.IOException,
                     AutomationException

The color used to render the element created by this tool.

Parameters:

pColor - The pColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public int getColor()
             throws java.io.IOException,
                    AutomationException

The color used to render the element created by this tool.

Description

The ink Color used by the ControlsInkGenericDrawTool. Internally the Color is stored as a long integer where the value may be calculated for any RGB combination as follows: RGB = (Red) + (Green * 256) + (Blue * 256 * 256). Where Red, Green and Blue are Long Integers within the range 0 - 255.

By default Color is black and corresponds to RGB (0, 0, 0).

Returns:

The pColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pWidth)
              throws java.io.IOException,
                     AutomationException

The width (in mm) used to render the element created by this tool.

Parameters:

pWidth - The pWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException

The width (in mm) used to render the element created by this tool.

Description

The ink Width used by the ControlsInkGenericDrawTool, specified in HIMETRIC units (1 HIMETRIC = 0.01 mm). By default Width is 10.

Returns:

The pWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(int pTrans)
                     throws java.io.IOException,
                            AutomationException

The transparency used to render the element created by this tool.

Parameters:

pTrans - The pTrans (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public int getTransparency()
                    throws java.io.IOException,
                           AutomationException

The transparency used to render the element created by this tool.

Description

The Transparency used by the ControlsInkGenericDrawTool. Transparency is the degree to which the Color is opaque. 0 for opaque and 255 for transparent. By default Transparency is 0.

Returns:

The pTrans

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipType

public void setTipType(int pTipType)
                throws java.io.IOException,
                       AutomationException

The pen tip type used to render the element created by this tool.

Parameters:

pTipType - A com.esri.arcgis.carto.ESRITPCStylusType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipType

public int getTipType()
               throws java.io.IOException,
                      AutomationException

The pen tip type used to render the element created by this tool.

Description

The ink TipType used by the ControlsInkGenericDrawTool. By default TipType is ETPC_Ball.

Returns:

A com.esri.arcgis.carto.ESRITPCStylusType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.