com.esri.arcgis.display
Class MultiLayerMarkerSymbol

java.lang.Object
  extended bycom.esri.arcgis.display.MultiLayerMarkerSymbol
All Implemented Interfaces:
IClone, ILayerColorLock, ILayerVisible, IMapLevel, IMarkerBackgroundSupport, IMarkerSymbol, IMask, IMultiLayerMarkerSymbol, IPersist, IPersistStream, IPropertySupport, ISymbol, ISymbolRotation, java.io.Serializable

public class MultiLayerMarkerSymbol
extends java.lang.Object
implements IMultiLayerMarkerSymbol, IMapLevel, ISymbol, ISymbolRotation, IMask, IMarkerBackgroundSupport, ILayerVisible, ILayerColorLock, IPropertySupport, IPersistStream, IPersist, IClone

A marker symbol that contains one or more layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The MultiLayerMarkerSymbol is used for creating marker symbols consisting of multiple layers.

See Also:
Serialized Form

Constructor Summary
MultiLayerMarkerSymbol()
          Constructs a MultiLayerMarkerSymbol using ArcGIS Engine.
MultiLayerMarkerSymbol(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void addLayer(IMarkerSymbol markerLayer)
          Add marker symbol layer.
 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 clearLayers()
          Remove all symbol layers.
 void deleteLayer(IMarkerSymbol markerLayer)
          Delete marker symbol layer.
 void draw(IGeometry geometry)
          Draws the specified shape.
 void drawLayer(int index, IGeometry geometry)
          Draw a symbol layer.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getAngle()
          Marker symbol angle.
 IClone getAsIClone()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerColorLock getAsILayerColorLock()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerVisible getAsILayerVisible()
          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.
 IMarkerBackgroundSupport getAsIMarkerBackgroundSupport()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMask getAsIMask()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMultiLayerMarkerSymbol getAsIMultiLayerMarkerSymbol()
          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.
 ISymbolRotation getAsISymbolRotation()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMarkerBackground getBackground()
          The marker background.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String getClsid()
           
 IColor getColor()
          Marker symbol color.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 IMarkerSymbol getLayer(int index)
          Marker symbol per index position.
 int getLayerCount()
          Symbol layer count.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 double getMaskSize()
          The mask size.
 int getMaskStyle()
          The mask style.
 IFillSymbol getMaskSymbol()
          The mask symbol.
 int getROP2()
          Raster operation code for pixel drawing.
 double getSize()
          Marker symbol size.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 double getXOffset()
          Symbol X-axis offset from point location.
 double getYOffset()
          Symbol Y-axis offset from point location.
 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 isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isLayerColorLock(int layerIndex)
          Indicates if a color lock is present for the layer at the specified index.
 boolean isLayerVisible(int layerIndex)
          Indicates if the layer at the specified index is visible.
 boolean isRotateWithTransform()
          Indicates if the symbol rotates with the display.
 void load(IStream pstm)
          Supported Platforms
 void moveLayer(IMarkerSymbol markerLayer, int toIndex)
          Change layer 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 setAllColorLocked(boolean allLocked)
          Indicates if the color is locked for all layers.
 void setAllVisible(boolean allVisible)
          Indicates if all the layers are visible or invisible.
 void setAngle(double angle)
          Marker symbol angle.
 void setBackgroundByRef(IMarkerBackground background)
          The marker background.
 void setColor(IColor color)
          Marker symbol color.
 void setLayerColorLock(int layerIndex, boolean colorLock)
          Indicates if a color lock is present for the layer at the specified index.
 void setLayerVisible(int layerIndex, boolean visible)
          Indicates if the layer at the specified index is visible.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setMaskSize(double size)
          The mask size.
 void setMaskStyle(int style)
          The mask style.
 void setMaskSymbolByRef(IFillSymbol fillSym)
          The mask symbol.
 void setROP2(int drawMode)
          Raster operation code for pixel drawing.
 void setRotateWithTransform(boolean flag)
          Indicates if the symbol rotates with the display.
 void setSize(double size)
          Marker symbol size.
 void setupDC(int hDC, ITransformation transformation)
          Prepares the DC for drawing the symbol.
 void setXOffset(double xOffset)
          Symbol X-axis offset from point location.
 void setYOffset(double yOffset)
          Symbol Y-axis offset from point location.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiLayerMarkerSymbol

public MultiLayerMarkerSymbol()
                       throws java.io.IOException,
                              java.net.UnknownHostException
Constructs a MultiLayerMarkerSymbol using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MultiLayerMarkerSymbol

public MultiLayerMarkerSymbol(java.lang.Object obj)
                       throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a MultiLayerMarkerSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MultiLayerMarkerSymbol.
MultiLayerMarkerSymbol theMultiLayerMarkerSymbol = (MultiLayerMarkerSymbol) 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()

getAsIMultiLayerMarkerSymbol

public IMultiLayerMarkerSymbol getAsIMultiLayerMarkerSymbol()
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.


getAsISymbolRotation

public ISymbolRotation getAsISymbolRotation()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMask

public IMask getAsIMask()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMarkerBackgroundSupport

public IMarkerBackgroundSupport getAsIMarkerBackgroundSupport()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerVisible

public ILayerVisible getAsILayerVisible()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerColorLock

public ILayerColorLock getAsILayerColorLock()
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


getLayerCount

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Symbol layer count.

Supported Platforms

Windows, Solaris, Linux

Description

LayerCount returns the number of constituent symbols.

Specified by:
getLayerCount in interface IMultiLayerMarkerSymbol
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public IMarkerSymbol getLayer(int index)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Marker symbol per index position.

Supported Platforms

Windows, Solaris, Linux

Description

Layer returns the marker symbol at the specified layer in a IMultiLayerMarkerSymbol . Use LayerCount beforehand to determine how many layers currently exist in a IMultiLayerMarkerSymbol .

Specified by:
getLayer in interface IMultiLayerMarkerSymbol
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(IMarkerSymbol markerLayer)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Add marker symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

AddLayer adds the specified marker symbol to a IMultiLayerMarkerSymbol . This symbol will draw in the topmost position in the IMultiLayerMarkerSymbol. The layer can be of any type supported by the IMarkerSymbol interface except types implementing IMultiLayerMarkerSymbol.  In this case an E_INVALIDARG HRESULT will be thrown. Therefore, a MultiLayerMarkerSymbol cannot be imbeded within another MultiLayerMarkerSymbol.

Specified by:
addLayer in interface IMultiLayerMarkerSymbol
Parameters:
markerLayer - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteLayer

public void deleteLayer(IMarkerSymbol markerLayer)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Delete marker symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

DeleteLayer deletes the specified layer in a IMultiLayerMarkerSymbol . Use LayerCount beforehand to determine how many layers currently exist in a IMultiLayerMarkerSymbol .

Specified by:
deleteLayer in interface IMultiLayerMarkerSymbol
Parameters:
markerLayer - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

moveLayer

public void moveLayer(IMarkerSymbol markerLayer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Change layer index position.

Supported Platforms

Windows, Solaris, Linux

Description

MoveLayer moves the marker symbol to the specified index in an IMultiLayerMarkerSymbol 's list of constituent symbols. Use LayerCount beforehand to determine how many layers currently exist in a IMultiLayerMarkerSymbol . Note that the marker symbol you specify should be determined using the Layer method on the current IMultiLayerMarkerSymbol .

Specified by:
moveLayer in interface IMultiLayerMarkerSymbol
Parameters:
markerLayer - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
toIndex - The toIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearLayers

public void clearLayers()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Remove all symbol layers.

Supported Platforms

Windows, Solaris, Linux

Description

ClearLayers removes all layers in an IMultiLayerMarkerSymbol .

Specified by:
clearLayers in interface IMultiLayerMarkerSymbol
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

drawLayer

public void drawLayer(int index,
                      IGeometry geometry)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMultiLayerMarkerSymbol
Draw a symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

DrawLayer draws the IMarkerSymbol stored at the specified index within the IMultiLayerMarkerSymbol.

Specified by:
drawLayer in interface IMultiLayerMarkerSymbol
Parameters:
index - The index (in)
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.

getSize

public double getSize()
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:
getSize in interface IMarkerSymbol
Returns:
The size
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:
setSize in interface IMarkerSymbol
Parameters:
size - The size (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: IMarkerSymbol
Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.
Color is not supported by the BarChartSymbol coclass. 

Specified by:
getColor in interface IMarkerSymbol
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.
Color is not supported by the BarChartSymbol coclass.

Specified by:
setColor in interface IMarkerSymbol
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).
Angle is not supported by the BarChartSymbol coclass.

Specified by:
getAngle in interface IMarkerSymbol
Returns:
The angle
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAngle

public void setAngle(double angle)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).
Angle is not supported by the BarChartSymbol coclass.

Specified by:
setAngle in interface IMarkerSymbol
Parameters:
angle - The angle (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getXOffset

public double getXOffset()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMarkerSymbol
Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
getXOffset in interface IMarkerSymbol
Returns:
The xOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
setXOffset in interface IMarkerSymbol
Parameters:
xOffset - The xOffset (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getYOffset

public double getYOffset()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMarkerSymbol
Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
getYOffset in interface IMarkerSymbol
Returns:
The yOffset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setYOffset

public void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
setYOffset in interface IMarkerSymbol
Parameters:
yOffset - The yOffset (in)
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.

isRotateWithTransform

public boolean isRotateWithTransform()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ISymbolRotation
Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRotateWithTransform in interface ISymbolRotation
Returns:
The flag
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISymbolRotation
Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRotateWithTransform in interface ISymbolRotation
Parameters:
flag - The flag (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMaskStyle

public int getMaskStyle()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMask
The mask style.

Supported Platforms

Windows, Solaris, Linux

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Specified by:
getMaskStyle in interface IMask
Returns:
A com.esri.arcgis.display.esriMaskStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskStyle

public void setMaskStyle(int style)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMask
The mask style.

Supported Platforms

Windows, Solaris, Linux

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Specified by:
setMaskStyle in interface IMask
Parameters:
style - A com.esri.arcgis.display.esriMaskStyle constant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMaskSize

public double getMaskSize()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IMask
The mask size.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Specified by:
getMaskSize in interface IMask
Returns:
The size
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskSize

public void setMaskSize(double size)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMask
The mask size.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Specified by:
setMaskSize in interface IMask
Parameters:
size - The size (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMaskSymbol

public IFillSymbol getMaskSymbol()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IMask
The mask symbol.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol interface can be used.

Specified by:
getMaskSymbol in interface IMask
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMaskSymbolByRef

public void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IMask
The mask symbol.

Specified by:
setMaskSymbolByRef in interface IMask
Parameters:
fillSym - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

public IMarkerBackground getBackground()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IMarkerBackgroundSupport
The marker background.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackground in interface IMarkerBackgroundSupport
Returns:
A reference to a com.esri.arcgis.display.IMarkerBackground
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

public void setBackgroundByRef(IMarkerBackground background)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IMarkerBackgroundSupport
The marker background.

Specified by:
setBackgroundByRef in interface IMarkerBackgroundSupport
Parameters:
background - A reference to a com.esri.arcgis.display.IMarkerBackground (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLayerVisible

public boolean isLayerVisible(int layerIndex)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayerVisible
Indicates if the layer at the specified index is visible.

Supported Platforms

Windows, Solaris, Linux

Description

LayerVisible indicates whether a specefic layer of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be displayed when the symbol is rendered.

Specified by:
isLayerVisible in interface ILayerVisible
Parameters:
layerIndex - The layerIndex (in)
Returns:
The visible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerVisible

public void setLayerVisible(int layerIndex,
                            boolean visible)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ILayerVisible
Indicates if the layer at the specified index is visible.

Supported Platforms

Windows, Solaris, Linux

Description

LayerVisible indicates whether a specefic layer of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be displayed when the symbol is rendered.

Specified by:
setLayerVisible in interface ILayerVisible
Parameters:
layerIndex - The layerIndex (in)
visible - The visible (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllVisible

public void setAllVisible(boolean allVisible)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ILayerVisible
Indicates if all the layers are visible or invisible.

Specified by:
setAllVisible in interface ILayerVisible
Parameters:
allVisible - The allVisible (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isLayerColorLock

public boolean isLayerColorLock(int layerIndex)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ILayerColorLock
Indicates if a color lock is present for the layer at the specified index.

Supported Platforms

Windows, Solaris, Linux

Description

LayerColorLock indicates whether a specefic layer of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be limited to the current color. When LayerColorLock is True the color cannot be changed.

Remarks

Set the LayerColorLock to TRUE to lock the color of layer at the given layer index. ISymbol::Put_Color checks this flag to determine if the color changes will be applied.

Specified by:
isLayerColorLock in interface ILayerColorLock
Parameters:
layerIndex - The layerIndex (in)
Returns:
The colorLock
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerColorLock

public void setLayerColorLock(int layerIndex,
                              boolean colorLock)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayerColorLock
Indicates if a color lock is present for the layer at the specified index.

Supported Platforms

Windows, Solaris, Linux

Description

LayerColorLock indicates whether a specefic layer of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be limited to the current color. When LayerColorLock is True the color cannot be changed.

Remarks

Set the LayerColorLock to TRUE to lock the color of layer at the given layer index. ISymbol::Put_Color checks this flag to determine if the color changes will be applied.

Specified by:
setLayerColorLock in interface ILayerColorLock
Parameters:
layerIndex - The layerIndex (in)
colorLock - The colorLock (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllColorLocked

public void setAllColorLocked(boolean allLocked)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayerColorLock
Indicates if the color is locked for all layers.

Specified by:
setAllColorLocked in interface ILayerColorLock
Parameters:
allLocked - The allLocked (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.