com.esri.arcgis.display
Class MultiLayerFillSymbol

java.lang.Object
  extended bycom.esri.arcgis.display.MultiLayerFillSymbol
All Implemented Interfaces:
IClone, IFillSymbol, ILayerColorLock, ILayerVisible, IMapLevel, IMultiLayerFillSymbol, IPersist, IPersistStream, IPropertySupport, ISymbol, java.io.Serializable

public class MultiLayerFillSymbol
extends java.lang.Object
implements IMultiLayerFillSymbol, IMapLevel, ISymbol, ILayerVisible, ILayerColorLock, IPropertySupport, IPersistStream, IPersist, IClone

A fill 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 MultiLayerFillSymbol is used for creating fill symbols consisting of multiple layers.

See Also:
Serialized Form

Constructor Summary
MultiLayerFillSymbol()
          Constructs a MultiLayerFillSymbol using ArcGIS Engine.
MultiLayerFillSymbol(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void addLayer(IFillSymbol fillLayer)
          Add fill 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(IFillSymbol fillLayer)
          Delete fill 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.
 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.
 IMultiLayerFillSymbol getAsIMultiLayerFillSymbol()
          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.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String getClsid()
           
 IColor getColor()
          Fill color.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 IFillSymbol getLayer(int index)
          Fill symbol per layer position.
 int getLayerCount()
          Symbol layer count.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 ILineSymbol getOutline()
          Line symbol of fill outline.
 int getROP2()
          Raster operation code for pixel drawing.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 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.
 void load(IStream pstm)
          Supported Platforms
 void moveLayer(IFillSymbol fillLayer, int toIndex)
          Change symbol layer position index.
 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 setColor(IColor color)
          Fill 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 setOutline(ILineSymbol outlineSym)
          Line symbol of fill outline.
 void setROP2(int drawMode)
          Raster operation code for pixel drawing.
 void setupDC(int hDC, ITransformation transformation)
          Prepares the DC for drawing the symbol.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiLayerFillSymbol

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

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

MultiLayerFillSymbol

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

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

getAsIMultiLayerFillSymbol

public IMultiLayerFillSymbol getAsIMultiLayerFillSymbol()
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.


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: IMultiLayerFillSymbol
Symbol layer count.

Supported Platforms

Windows, Solaris, Linux

Description

LayerCount returns the total number of layers currently contained in the IMultiLayerFillSymbol.

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

getLayer

public IFillSymbol getLayer(int index)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IMultiLayerFillSymbol
Fill symbol per layer position.

Supported Platforms

Windows, Solaris, Linux

Description

GetLayer returns an IFillSymbol from the specified index of the IMultiLayerFillSymbol.

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

addLayer

public void addLayer(IFillSymbol fillLayer)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMultiLayerFillSymbol
Add fill symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

AddLayer adds a single layer to the IMultiLayerFillSymbol. The layer can be of any type supported by the IFillSymbol interface except types implementing IMultiLayerFillSymbol.  In this case an E_INVALIDARG HRESULT will be thrown. Therefore, a MultiLayerFillSymbol cannot be imbeded within another MultiLayerFillSymbol.

Specified by:
addLayer in interface IMultiLayerFillSymbol
Parameters:
fillLayer - 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.

deleteLayer

public void deleteLayer(IFillSymbol fillLayer)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMultiLayerFillSymbol
Delete fill symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

DeleteLayer deletes the layer at the given index.

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

moveLayer

public void moveLayer(IFillSymbol fillLayer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMultiLayerFillSymbol
Change symbol layer position index.

Supported Platforms

Windows, Solaris, Linux

Description

MoveLayer moves the spcefied IFillSymbol to the specified index within the IMultiLayerFillSymbol.

Specified by:
moveLayer in interface IMultiLayerFillSymbol
Parameters:
fillLayer - A reference to a com.esri.arcgis.display.IFillSymbol (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: IMultiLayerFillSymbol
Remove all symbol layers.

Supported Platforms

Windows, Solaris, Linux

Description

ClearLayers removes all the layers contained within the IMultiLayerFillSymbol.

Specified by:
clearLayers in interface IMultiLayerFillSymbol
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
Description copied from interface: IMultiLayerFillSymbol
Draw a symbol layer.

Supported Platforms

Windows, Solaris, Linux

Description

DrawLayer draws the IFillSymbol stored at the specified index within the IMultiLayerFillSymbol.

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

getColor

public IColor getColor()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IFillSymbol
Fill color.

Supported Platforms

Windows, Solaris, Linux

Description

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

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

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IFillSymbol
Fill color.

Supported Platforms

Windows, Solaris, Linux

Description

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

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

getOutline

public ILineSymbol getOutline()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IFillSymbol
Line symbol of fill outline.

Supported Platforms

Windows, Solaris, Linux

Description

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

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

setOutline

public void setOutline(ILineSymbol outlineSym)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IFillSymbol
Line symbol of fill outline.

Supported Platforms

Windows, Solaris, Linux

Description

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

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

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.

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.