com.esri.arcgis.display
Class DotDensityFillSymbol

java.lang.Object
  com.esri.arcgis.display.DotDensityFillSymbol

All Implemented Interfaces:

IClone, IDotDensityFillSymbol, IDotDensityFillSymbol2, IDotDensityMasking, IFillSymbol, IMapLevel, IPersist, IPersistStream, IPropertySupport, ISymbol, ISymbolArray, java.io.Serializable

public class DotDensityFillSymbol

extends java.lang.Object

implements IDotDensityFillSymbol, IDotDensityFillSymbol2, IDotDensityMasking, ISymbolArray, IMapLevel, ISymbol, IPropertySupport, IPersistStream, IPersist, IClone

Defines a dot density fill symbol, a data driven symbol commonly used with the dot density renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Description

Data driven fill symbol used with the DotDensityRenderer.

See Also:

Serialized Form

Constructor Summary

DotDensityFillSymbol()
Constructs a DotDensityFillSymbol using ArcGIS Engine.

DotDensityFillSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addSymbol(ISymbol symbol) Adds a symbol to the array.
boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canApply(java.lang.Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
void	clearSymbols() Removes all symbols from the array.
void	deleteSymbol(ISymbol symbol) Delete the given symbol.
void	draw(IGeometry geometry) Draws the specified shape.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDotDensityFillSymbol	getAsIDotDensityFillSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDotDensityFillSymbol2	getAsIDotDensityFillSymbol2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDotDensityMasking	getAsIDotDensityMasking() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMapLevel	getAsIMapLevel() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPropertySupport	getAsIPropertySupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbol	getAsISymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbolArray	getAsISymbolArray() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IColor	getBackgroundColor() The background color.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IColor	getColor() Fill color.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
int	getDotCount(int index) The number of dots used to fill.
double	getDotSize() The size of dots used to fill.
double	getDotSpacing() The distance between dot centers, expressed as a percentage of dot size.
int	getMapLevel() Current map level for drawing multi-level symbols.
IGeometry	getMaskGeometry() The geometry used for masking (can be a geometry collection).
ILineSymbol	getOutline() Line symbol of fill outline.
java.lang.Object	getRandomSeed() Defines how the random generator is initialized to draw dots randomly.
int	getROP2() Raster operation code for pixel drawing.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
ISymbol	getSymbol(int index) The symbol at the index position.
int	getSymbolCount() The number of symbols.
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isExcludeMask() Indicates if the dots are to be excluded from the mask area.
boolean	isFixedPlacement() Indicates if the dots are always placed at the same location (the alternative is random placement).
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
boolean	isUseMasking() Indicates if masking is used.
void	load(IStream pstm) Supported Platforms
void	moveSymbol(ISymbol symbol, int toIndex) Moves the given symbol to new index position.
void	queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary) Fills an existing polygon with the boundary of the specified symbol.
void	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setBackgroundColor(IColor color) The background color.
void	setColor(IColor color) Fill color.
void	setDotCount(int index, int dotCount) The number of dots used to fill.
void	setDotSize(double dotSize) The size of dots used to fill.
void	setDotSpacing(double dotSpacing) The distance between dot centers, expressed as a percentage of dot size.
void	setExcludeMask(boolean excludeMask) Indicates if the dots are to be excluded from the mask area.
void	setFixedPlacement(boolean fixedPlacement) Indicates if the dots are always placed at the same location (the alternative is random placement).
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setMaskGeometryByRef(IGeometry geometry) The geometry used for masking (can be a geometry collection).
void	setOutline(ILineSymbol outlineSym) Line symbol of fill outline.
void	setRandomSeed(java.lang.Object seed) Defines how the random generator is initialized to draw dots randomly.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setSymbolByRef(int index, ISymbol symbol) The symbol at the index position.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setUseMasking(boolean useMasking) Indicates if masking is used.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DotDensityFillSymbol

public DotDensityFillSymbol()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a DotDensityFillSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DotDensityFillSymbol

public DotDensityFillSymbol(java.lang.Object obj)
                     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a DotDensityFillSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DotDensityFillSymbol.
DotDensityFillSymbol theDotDensityFillSymbol = (DotDensityFillSymbol) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIDotDensityFillSymbol

public IDotDensityFillSymbol getAsIDotDensityFillSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDotDensityFillSymbol2

public IDotDensityFillSymbol2 getAsIDotDensityFillSymbol2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDotDensityMasking

public IDotDensityMasking getAsIDotDensityMasking()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISymbolArray

public ISymbolArray getAsISymbolArray()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMapLevel

public IMapLevel getAsIMapLevel()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISymbol

public ISymbol getAsISymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getDotSize

public double getDotSize()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDotDensityFillSymbol

The size of dots used to fill.

Supported Platforms

Windows, Solaris, Linux

Description

The size of the dots used for filling symbols. Decrease the DotSize for a less dense map, or increase for a more dense map. This value overrides the size values of all of the dot symbols set through ISymbolArray.

Specified by:

getDotSize in interface IDotDensityFillSymbol

Returns:

The dotSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDotSize

public void setDotSize(double dotSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IDotDensityFillSymbol

The size of dots used to fill.

Supported Platforms

Windows, Solaris, Linux

Description

The size of the dots used for filling symbols. Decrease the DotSize for a less dense map, or increase for a more dense map. This value overrides the size values of all of the dot symbols set through ISymbolArray .

Specified by:

setDotSize in interface IDotDensityFillSymbol

Parameters:

dotSize - The dotSize (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDotCount

public int getDotCount(int index)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IDotDensityFillSymbol

The number of dots used to fill.

Supported Platforms

Windows, Solaris, Linux

Description

Literally, the number of dots used for filling. Typically, this value is calculated by the DotDensityRenderer based on IDotDensityRenderer.DotValue and the data value for the feature being symbolized.

Specified by:

getDotCount in interface IDotDensityFillSymbol

Parameters:

index - The index (in)

Returns:

The dotCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDotCount

public void setDotCount(int index,
                        int dotCount)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IDotDensityFillSymbol

The number of dots used to fill.

Supported Platforms

Windows, Solaris, Linux

Description

Literally, the number of dots used for filling. Typically, this value is calculated based on IDotDensityRenderer.DotValue and the data value for the feature being symbolized.

Specified by:

setDotCount in interface IDotDensityFillSymbol

Parameters:

index - The index (in)

dotCount - The dotCount (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDotSpacing

public double getDotSpacing()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IDotDensityFillSymbol

The distance between dot centers, expressed as a percentage of dot size.

Supported Platforms

Windows, Solaris, Linux

Description

DotSpacing is expressed as a percentage of dot size, where 100% means that dots can just touch and 0% means that dots can completely overlap. The default is 0%.

You can set a DotSpacing of greater than 100% to enforce a gap between dots.

Remarks

set_DotSpacing is currently not implemented .

Specified by:

getDotSpacing in interface IDotDensityFillSymbol

Returns:

The dotSpacing

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDotSpacing

public void setDotSpacing(double dotSpacing)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IDotDensityFillSymbol

The distance between dot centers, expressed as a percentage of dot size.

Supported Platforms

Windows, Solaris, Linux

Description

DotSpacing is expressed as a percentage of dot size, where 100% means that dots can just touch and 0% means that dots can completely overlap. Default is 0%.

You can set a DotSpacing of greater than 100% to enforce a gap between dots.

Remarks

set_DotSpacing is currently not implemented.

Specified by:

setDotSpacing in interface IDotDensityFillSymbol

Parameters:

dotSpacing - The dotSpacing (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isFixedPlacement

public boolean isFixedPlacement()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IDotDensityFillSymbol

Indicates if the dots are always placed at the same location (the alternative is random placement).

Supported Platforms

Windows, Solaris, Linux

Description

Specifies whether or not dots will be drawn at their same positions upon successive redraws. If True, then the dots will be fixed in place on successive redraws. If False, then dots will be placed randomly.

Specified by:

isFixedPlacement in interface IDotDensityFillSymbol

Returns:

The fixedPlacement

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFixedPlacement

public void setFixedPlacement(boolean fixedPlacement)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IDotDensityFillSymbol

Indicates if the dots are always placed at the same location (the alternative is random placement).

Supported Platforms

Windows, Solaris, Linux

Description

Use this property to control whether dots are placed randomly upon successive redraws, or whether their location is fixed. If True, then dot location is fixed.

Specified by:

setFixedPlacement in interface IDotDensityFillSymbol

Parameters:

fixedPlacement - The fixedPlacement (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IDotDensityFillSymbol

The background color.

Supported Platforms

Windows, Solaris, Linux

Description

The color drawn behind the dots. A DotDensityFillSymbol has no true background fill symbol.

Specified by:

getBackgroundColor in interface IDotDensityFillSymbol

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDotDensityFillSymbol

The background color.

Supported Platforms

Windows, Solaris, Linux

Description

The color drawn behind the dots. A DotDensityFillSymbol has no true background fill symbol.

Specified by:

setBackgroundColor in interface IDotDensityFillSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getColor

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

Description copied from interface: IFillSymbol

Fill color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color for a FillSymbol object. Any IColor object can be used.

Specified by:

getColor in interface IFillSymbol

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IFillSymbol

Fill color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color for a FillSymbol object. Any IColor object can be used.

Specified by:

setColor in interface IFillSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getOutline

public ILineSymbol getOutline()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IFillSymbol

Line symbol of fill outline.

Supported Platforms

Windows, Solaris, Linux

Description

Outline is the border for a FillSymbol object. Any ILineSymbol object can be used.

Specified by:

getOutline in interface IFillSymbol

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOutline

public void setOutline(ILineSymbol outlineSym)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IFillSymbol

Line symbol of fill outline.

Supported Platforms

Windows, Solaris, Linux

Description

Outline is the border for a FillSymbol object. Any ILineSymbol object can be used.

Specified by:

setOutline in interface IFillSymbol

Parameters:

outlineSym - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRandomSeed

public java.lang.Object getRandomSeed()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IDotDensityFillSymbol2

Defines how the random generator is initialized to draw dots randomly.

Supported Platforms

Windows, Solaris, Linux

Remarks

The random seed for dot generation a 32-bit unsigned integer value.

Specifies the random seed used for generation of placement position. If FixedPlacement is True, then the dots will be fixed in place on successive redraws based on the random seed, which will not be modified. If FixedPlacement is False, then dots will be placed randomly as the random seed will be updated each draw.

Specified by:

getRandomSeed in interface IDotDensityFillSymbol2

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setRandomSeed

public void setRandomSeed(java.lang.Object seed)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IDotDensityFillSymbol2

Defines how the random generator is initialized to draw dots randomly.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRandomSeed in interface IDotDensityFillSymbol2

Parameters:

seed - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMaskGeometryByRef

public void setMaskGeometryByRef(IGeometry geometry)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IDotDensityMasking

The geometry used for masking (can be a geometry collection).

Specified by:

setMaskGeometryByRef in interface IDotDensityMasking

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaskGeometry

public IGeometry getMaskGeometry()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IDotDensityMasking

The geometry used for masking (can be a geometry collection).

Supported Platforms

Windows, Solaris, Linux

Description

The geometry used for masking. This usually comes from IDotDensityRenderer.ControlLayer.

Specified by:

getMaskGeometry in interface IDotDensityMasking

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseMasking

public boolean isUseMasking()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IDotDensityMasking

Indicates if masking is used.

Supported Platforms

Windows, Solaris, Linux

Description

Specifies whether or not dot density masking is used. If True , then the MaskGeometry is used to control the placement of dots within polygon features of the rendered layer.

Specified by:

isUseMasking in interface IDotDensityMasking

Returns:

The useMasking

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseMasking

public void setUseMasking(boolean useMasking)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IDotDensityMasking

Indicates if masking is used.

Supported Platforms

Windows, Solaris, Linux

Description

P>Controls whether masking is used. If True, then the MaskGeometry is used to control the placement of dots.

Specified by:

setUseMasking in interface IDotDensityMasking

Parameters:

useMasking - The useMasking (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isExcludeMask

public boolean isExcludeMask()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IDotDensityMasking

Indicates if the dots are to be excluded from the mask area.

Supported Platforms

Windows, Solaris, Linux

Description

Specifies whether or not dots are only to be placed outside the polygons of the layer specified in IDotDensityRenderer::ControlLayer, or whether or not they are only to be placed inside these polygons.

Remarks

To turn dot density masking on or off set UseMasking.

Specified by:

isExcludeMask in interface IDotDensityMasking

Returns:

The excludeMask

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExcludeMask

public void setExcludeMask(boolean excludeMask)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IDotDensityMasking

Indicates if the dots are to be excluded from the mask area.

Supported Platforms

Windows, Solaris, Linux

Description

If UseMasking is True, then this property controls whether dots are placed either inside or outside the features in the masking layer. If True, then dots are only placed outside the masked area.

Specified by:

setExcludeMask in interface IDotDensityMasking

Parameters:

excludeMask - The excludeMask (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolCount

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

Description copied from interface: ISymbolArray

The number of symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbolCount in interface ISymbolArray

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSymbol

public ISymbol getSymbol(int index)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

The symbol at the index position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface ISymbolArray

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSymbolByRef

public void setSymbolByRef(int index,
                           ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISymbolArray

The symbol at the index position.

Specified by:

setSymbolByRef in interface ISymbolArray

Parameters:

index - The index (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

addSymbol

public void addSymbol(ISymbol symbol)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ISymbolArray

Adds a symbol to the array.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteSymbol

public void deleteSymbol(ISymbol symbol)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

Delete the given symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

moveSymbol

public void moveSymbol(ISymbol symbol,
                       int toIndex)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ISymbolArray

Moves the given symbol to new index position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

moveSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

toIndex - The toIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearSymbols

public void clearSymbols()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

Removes all symbols from the array.

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearSymbols in interface ISymbolArray

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMapLevel

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

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Prepares the DC for drawing the symbol.

Specified by:

setupDC in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetDC

public void resetDC()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Restores DC to original state.

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetDC in interface ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: ISymbol

Draws the specified shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ISymbol

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ISymbol

Fills an existing polygon with the boundary of the specified symbol.

Supported Platforms

Windows, Solaris, Linux

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

Specified by:

queryBoundary in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getROP2

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

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getROP2 in interface ISymbol

Returns:

A com.esri.arcgis.display.esriRasterOpCode constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setROP2

public void setROP2(int drawMode)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setROP2 in interface ISymbol

Parameters:

drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at any given time.

Supported Platforms

Windows, Solaris, Linux

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at that particular moment.

Supported Platforms

Windows, Solaris, Linux

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IPropertySupport

The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

Current will return you the current object of the specified type. For instance, I may ask a CircleElement if it supports a Color object. If it does, then I can use Current to get the Color object currently applied to my CircleElement.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IPropertySupport

Applies the given property to the receiver and returns the old object.

Supported Platforms

Windows, Solaris, Linux

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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