com.esri.arcgis.display
Class MultiLayerMarkerSymbol

java.lang.Object
  extended by com.esri.arcgis.display.MultiLayerMarkerSymbol
All Implemented Interfaces:
ILayerColorLock, ILayerTags, ILayerVisible, IMapLevel, IMarkerBackgroundSupport, IMarkerMask, IMarkerSymbol, IMask, IMultiLayerMarkerSymbol, ISymbol, ISymbolRotation, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class MultiLayerMarkerSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMultiLayerMarkerSymbol, IMapLevel, ISymbol, ISymbolRotation, IMask, IMarkerMask, IMarkerBackgroundSupport, ILayerVisible, ILayerColorLock, IPropertySupport, IPersistStream, IPersist, IClone, ILayerTags, Externalizable

A marker symbol that contains one or more layers.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MultiLayerMarkerSymbol()
          Constructs a MultiLayerMarkerSymbol using ArcGIS Engine.
MultiLayerMarkerSymbol(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MultiLayerMarkerSymbol theMultiLayerMarkerSymbol = (MultiLayerMarkerSymbol) obj;
 
Method Summary
 void addLayer(IMarkerSymbol markerLayer)
          Add marker symbol layer.
 boolean applies(Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 Object apply(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(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(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getAngle()
          Marker symbol angle.
 IMarkerBackground getBackground()
          The marker background.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IColor getColor()
          Marker symbol color.
 Object getCurrent(Object pUnk)
          The object currently being used.
 IMarkerSymbol getLayer(int index)
          Marker symbol per index position.
 int getLayerCount()
          Symbol layer count.
 String getLayerTags(int layerIndex)
          Tags for the layer at the specified index.
 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)
          getSizeMax
 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()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if 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)
          load
 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 queryMarkerMask(int hDC, ITransformation transform, IGeometry geometry, IPolygon boundary)
          Returns the mask geometry for the marker.
 void readExternal(ObjectInput in)
           
 void resetDC()
          Restores DC to original state.
 void save(IStream pstm, int fClearDirty)
          save
 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 setLayerTags(int layerIndex, String tags)
          Tags 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

MultiLayerMarkerSymbol

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

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MultiLayerMarkerSymbol

public MultiLayerMarkerSymbol(Object obj)
                       throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MultiLayerMarkerSymbol theMultiLayerMarkerSymbol = (MultiLayerMarkerSymbol) obj;

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.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException
Symbol layer count.

Description

LayerCount returns the number of constituent symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLayer

public IMarkerSymbol getLayer(int index)
                       throws IOException,
                              AutomationException
Marker symbol per index position.

Product Availability

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

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

addLayer

public void addLayer(IMarkerSymbol markerLayer)
              throws IOException,
                     AutomationException
Add marker symbol layer.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deleteLayer

public void deleteLayer(IMarkerSymbol markerLayer)
                 throws IOException,
                        AutomationException
Delete marker symbol layer.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

moveLayer

public void moveLayer(IMarkerSymbol markerLayer,
                      int toIndex)
               throws IOException,
                      AutomationException
Change layer index position.

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 .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clearLayers

public void clearLayers()
                 throws IOException,
                        AutomationException
Remove all symbol layers.

Description

ClearLayers removes all layers in an IMultiLayerMarkerSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawLayer

public void drawLayer(int index,
                      IGeometry geometry)
               throws IOException,
                      AutomationException
Draw a symbol layer.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawLayer in interface IMultiLayerMarkerSymbol
Parameters:
index - The index (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws IOException,
                      AutomationException
Marker symbol size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSize

public void setSize(double size)
             throws IOException,
                    AutomationException
Marker symbol size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getColor

public IColor getColor()
                throws IOException,
                       AutomationException
Marker symbol color.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException
Marker symbol color.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAngle

public double getAngle()
                throws IOException,
                       AutomationException
Marker symbol angle.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAngle

public void setAngle(double angle)
              throws IOException,
                     AutomationException
Marker symbol angle.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getXOffset

public double getXOffset()
                  throws IOException,
                         AutomationException
Symbol X-axis offset from point location.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setXOffset

public void setXOffset(double xOffset)
                throws IOException,
                       AutomationException
Symbol X-axis offset from point location.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getYOffset

public double getYOffset()
                  throws IOException,
                         AutomationException
Symbol Y-axis offset from point location.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setYOffset

public void setYOffset(double yOffset)
                throws IOException,
                       AutomationException
Symbol Y-axis offset from point location.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws IOException,
                    AutomationException
Prepares the DC for drawing the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetDC

public void resetDC()
             throws IOException,
                    AutomationException
Restores DC to original state.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetDC in interface ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws IOException,
                 AutomationException
Draws the specified shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ISymbol
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
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 IOException,
                          AutomationException
Fills an existing polygon with the boundary of the specified symbol.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getROP2

public int getROP2()
            throws IOException,
                   AutomationException
Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getROP2 in interface ISymbol
Returns:
A com.esri.arcgis.display.esriRasterOpCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setROP2

public void setROP2(int drawMode)
             throws IOException,
                    AutomationException
Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setROP2 in interface ISymbol
Parameters:
drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRotateWithTransform

public boolean isRotateWithTransform()
                              throws IOException,
                                     AutomationException
Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws IOException,
                                   AutomationException
Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaskStyle

public int getMaskStyle()
                 throws IOException,
                        AutomationException
The mask style.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaskStyle

public void setMaskStyle(int style)
                  throws IOException,
                         AutomationException
The mask style.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaskSize

public double getMaskSize()
                   throws IOException,
                          AutomationException
The mask size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaskSize

public void setMaskSize(double size)
                 throws IOException,
                        AutomationException
The mask size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaskSymbol

public IFillSymbol getMaskSymbol()
                          throws IOException,
                                 AutomationException
The mask symbol.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaskSymbolByRef

public void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws IOException,
                               AutomationException
The mask symbol.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryMarkerMask

public void queryMarkerMask(int hDC,
                            ITransformation transform,
                            IGeometry geometry,
                            IPolygon boundary)
                     throws IOException,
                            AutomationException
Returns the mask geometry for the marker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryMarkerMask in interface IMarkerMask
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

public IMarkerBackground getBackground()
                                throws IOException,
                                       AutomationException
The marker background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBackgroundByRef

public void setBackgroundByRef(IMarkerBackground background)
                        throws IOException,
                               AutomationException
The marker background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isLayerVisible

public boolean isLayerVisible(int layerIndex)
                       throws IOException,
                              AutomationException
Indicates if the layer at the specified index is visible.

Product Availability

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

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

setLayerVisible

public void setLayerVisible(int layerIndex,
                            boolean visible)
                     throws IOException,
                            AutomationException
Indicates if the layer at the specified index is visible.

Product Availability

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

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

setAllVisible

public void setAllVisible(boolean allVisible)
                   throws IOException,
                          AutomationException
Indicates if all the layers are visible or invisible.

Description

SetAllVisible indicates whether all layers of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be displayed when the symbol is rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isLayerColorLock

public boolean isLayerColorLock(int layerIndex)
                         throws IOException,
                                AutomationException
Indicates if a color lock is present for the layer at the specified index.

Product Availability

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

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

setLayerColorLock

public void setLayerColorLock(int layerIndex,
                              boolean colorLock)
                       throws IOException,
                              AutomationException
Indicates if a color lock is present for the layer at the specified index.

Product Availability

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

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

setAllColorLocked

public void setAllColorLocked(boolean allLocked)
                       throws IOException,
                              AutomationException
Indicates if the color is locked for all layers.

Description

SetAllColorLocked indicates whether all layers of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be locked to their current color.

Remarks

Pass in TRUE to SetAllColorLocked method to prevent the color changes for all the layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAllColorLocked in interface ILayerColorLock
Parameters:
allLocked - The allLocked (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException
Indicates if the receiver can apply the given object at any given time.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
applies in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The applies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException
Indicates if the receiver can apply the given object at that particular moment.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canApply in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The canApply
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException
The object currently being used.

Product Availability

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

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException
Applies the given property to the receiver and returns the old object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerTags

public String getLayerTags(int layerIndex)
                    throws IOException,
                           AutomationException
Tags for the layer at the specified index.

Product Availability

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

Specified by:
getLayerTags in interface ILayerTags
Parameters:
layerIndex - The layerIndex (in)
Returns:
The tags
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerTags

public void setLayerTags(int layerIndex,
                         String tags)
                  throws IOException,
                         AutomationException
Tags for the layer at the specified index.

Product Availability

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

Specified by:
setLayerTags in interface ILayerTags
Parameters:
layerIndex - The layerIndex (in)
tags - The tags (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException