com.esri.arcgis.display
Class MultiLayerMarkerSymbol

java.lang.Object
  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, java.io.Externalizable, java.io.Serializable

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

COM Class 'MultiLayerMarkerSymbol'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'A marker symbol that contains one or more layers.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.display.IMultiLayerMarkerSymbol

IID, IID7914e5e4_c892_11d0_8bb6_080009ee4e41, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMarkerSymbol

IIDe6bdaa7c_4d35_11d0_98be_00805f7ced21

Fields inherited from interface com.esri.arcgis.display.IMapLevel

IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.display.ISymbol

IID, IIDf3435802_5779_11d0_98bf_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.display.ISymbolRotation

IID, IID84a1f5c2_d0a1_4e45_842b_149e857e8a9c, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMask

IID, IID6a7ef984_6924_11d2_980d_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMarkerMask

IID, IID572d1037_7815_11d3_9f6a_00c04f6bc8dd, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMarkerBackgroundSupport

IID, IID9ce9d410_ddeb_11d3_8216_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.display.ILayerVisible

IID, IIDd7301b50_e92e_11d2_98ce_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.display.ILayerColorLock

IID, IIDd7301b51_e92e_11d2_98ce_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPropertySupport

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.display.ILayerTags

IID, IID6322d37e_6b0e_4838_a146_ee463024976e, xxDummy

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.
MultiLayerMarkerSymbol theMultiLayerMarkerSymbol = (MultiLayerMarkerSymbol) obj;

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.
IMarkerBackground	getBackground() The marker background.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IColor	getColor() Marker symbol color.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMarkerSymbol	getLayer(int index) Marker symbol per index position.
int	getLayerCount() Symbol layer count.
java.lang.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(java.io.ObjectInput in)
void	release() Release a MultiLayerMarkerSymbol.
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, java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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.
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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a MultiLayerMarkerSymbol.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getLayerCount

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

Symbol layer count.

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

Marker symbol per index position.

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

Add marker symbol layer.

Specified by:

addLayer in interface IMultiLayerMarkerSymbol

Parameters:

markerLayer - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteLayer

public void deleteLayer(IMarkerSymbol markerLayer)
                 throws java.io.IOException,
                        AutomationException

Delete marker symbol layer.

Specified by:

deleteLayer in interface IMultiLayerMarkerSymbol

Parameters:

markerLayer - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveLayer

public void moveLayer(IMarkerSymbol markerLayer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException

Change layer index position.

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

Remove all symbol layers.

Specified by:

clearLayers in interface IMultiLayerMarkerSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawLayer

public void drawLayer(int index,
                      IGeometry geometry)
               throws java.io.IOException,
                      AutomationException

Draw a symbol layer.

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

Marker symbol size.

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

Marker symbol size.

Specified by:

setSize in interface IMarkerSymbol

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColor

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

Marker symbol color.

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

Marker symbol color.

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

Marker symbol angle.

Specified by:

getAngle in interface IMarkerSymbol

Returns:

The angle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws java.io.IOException,
                     AutomationException

Marker symbol angle.

Specified by:

setAngle in interface IMarkerSymbol

Parameters:

angle - The angle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXOffset

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

Symbol X-axis offset from point location.

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

Symbol X-axis offset from point location.

Specified by:

setXOffset in interface IMarkerSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYOffset

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

Symbol Y-axis offset from point location.

Specified by:

getYOffset in interface IMarkerSymbol

Returns:

The yOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYOffset

public void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException

Symbol Y-axis offset from point location.

Specified by:

setYOffset in interface IMarkerSymbol

Parameters:

yOffset - The yOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapLevel

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

Current map level for drawing multi-level symbols.

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapLevel

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

Current map level for drawing multi-level symbols.

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

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

Restores DC to original state.

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

Draws the specified shape.

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getROP2

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

Raster operation code for pixel drawing.

Specified by:

getROP2 in interface ISymbol

Returns:

A com.esri.arcgis.display.esriRasterOpCode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setROP2

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

Raster operation code for pixel drawing.

Specified by:

setROP2 in interface ISymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRotateWithTransform

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

Indicates if the symbol rotates with the display.

Specified by:

isRotateWithTransform in interface ISymbolRotation

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the symbol rotates with the display.

Specified by:

setRotateWithTransform in interface ISymbolRotation

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaskStyle

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

The mask style.

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

The mask style.

Specified by:

setMaskStyle in interface IMask

Parameters:

style - A com.esri.arcgis.display.esriMaskStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaskSize

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

The mask size.

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

The mask size.

Specified by:

setMaskSize in interface IMask

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaskSymbol

public IFillSymbol getMaskSymbol()
                          throws java.io.IOException,
                                 AutomationException

The mask symbol.

Specified by:

getMaskSymbol in interface IMask

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskSymbolByRef

public void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws java.io.IOException,
                               AutomationException

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.

queryMarkerMask

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

Returns the mask geometry for the marker.

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:

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

The marker background.

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

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

Indicates if the layer at the specified index is visible.

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

Indicates if the layer at the specified index is visible.

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

Indicates if all the layers are visible or invisible.

Specified by:

setAllVisible in interface ILayerVisible

Parameters:

allVisible - The allVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLayerColorLock

public boolean isLayerColorLock(int layerIndex)
                         throws java.io.IOException,
                                AutomationException

Indicates if a color lock is present for the layer at the specified index.

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

Indicates if a color lock is present for the layer at the specified index.

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

Indicates if the color is locked for all layers.

Specified by:

setAllColorLocked in interface ILayerColorLock

Parameters:

allLocked - The allLocked (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

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

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

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

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

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

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

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

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

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

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

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

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

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

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

getLayerTags

public java.lang.String getLayerTags(int layerIndex)
                              throws java.io.IOException,
                                     AutomationException

Tags for the layer at the specified index.

Specified by:

getLayerTags in interface ILayerTags

Parameters:

layerIndex - The layerIndex (in)

Returns:

The tags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerTags

public void setLayerTags(int layerIndex,
                         java.lang.String tags)
                  throws java.io.IOException,
                         AutomationException

Tags for the layer at the specified index.

Specified by:

setLayerTags in interface ILayerTags

Parameters:

layerIndex - The layerIndex (in)

tags - The tags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException