com.esri.arcgis.display
Class MarkerLineSymbol

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

All Implemented Interfaces:

ICartographicLineSymbol, IClone, IDisplayName, ILineProperties, ILineSymbol, IMapLevel, IMarkerLineSymbol, IPersist, IPersistStream, IPropertySupport, ISymbol, java.io.Serializable

public class MarkerLineSymbol

extends java.lang.Object

implements IMarkerLineSymbol, ICartographicLineSymbol, IMapLevel, ISymbol, ILineProperties, IPropertySupport, IPersistStream, IPersist, IClone, IDisplayName

A line symbol composed of repeating markers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The MarkerLineSymbol can be used to create a line symbol that is composed of one or more marker symbols.

See Also:

Serialized Form

Constructor Summary

MarkerLineSymbol()
Constructs a MarkerLineSymbol using ArcGIS Engine.

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

Method Summary

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	draw(IGeometry geometry) Draws the specified shape.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
ICartographicLineSymbol	getAsICartographicLineSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDisplayName	getAsIDisplayName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILineProperties	getAsILineProperties() 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.
IMarkerLineSymbol	getAsIMarkerLineSymbol() 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.
int	getCap() Line end cap style.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IColor	getColor() Line symbol color.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
int	getJoin() Line join style.
ILineDecoration	getLineDecoration() Line decoration element collection.
double	getLineStartOffset() The line start offset.
int	getMapLevel() Current map level for drawing multi-level symbols.
IMarkerSymbol	getMarkerSymbol() Symbol used for marker line.
double	getMiterLimit() Size threshold for showing mitered line joins.
java.lang.String	getNameString() The display name of an object.
double	getOffset() The line offset value.
int	getROP2() Raster operation code for pixel drawing.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
ITemplate	getTemplate() The line template.
double	getWidth() Line symbol width.
int	hashCode() the hashcode for this object
boolean	isDecorationOnTop() Indicates if the decoration is drawn on top.
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isFlip() Indicates if the line symbol is flipped.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
void	load(IStream pstm) Supported Platforms
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	setCap(int capStyle) Line end cap style.
void	setColor(IColor color) Line symbol color.
void	setDecorationOnTop(boolean onTop) Indicates if the decoration is drawn on top.
void	setFlip(boolean flip) Indicates if the line symbol is flipped.
void	setJoin(int joinStyle) Line join style.
void	setLineDecorationByRef(ILineDecoration lineDecoration) Line decoration element collection.
void	setLineStartOffset(double offset) The line start offset.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setMarkerSymbolByRef(IMarkerSymbol marker) Symbol used for marker line.
void	setMiterLimit(double miterLimit) Size threshold for showing mitered line joins.
void	setOffset(double offset) The line offset value.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setTemplateByRef(ITemplate theTemplate) The line template.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setWidth(double width) Line symbol width.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerLineSymbol

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

Constructs a MarkerLineSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MarkerLineSymbol

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

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

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

getAsIMarkerLineSymbol

public IMarkerLineSymbol getAsIMarkerLineSymbol()

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

getAsICartographicLineSymbol

public ICartographicLineSymbol getAsICartographicLineSymbol()

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.

getAsILineProperties

public ILineProperties getAsILineProperties()

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.

getAsIDisplayName

public IDisplayName getAsIDisplayName()

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

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IMarkerLineSymbol

Symbol used for marker line.

Supported Platforms

Windows, Solaris, Linux

Description

MarkerSymbol is the marker used as the line pattern. Any IMarkerSymbol interface can be used.

Specified by:

getMarkerSymbol in interface IMarkerLineSymbol

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.

setMarkerSymbolByRef

public void setMarkerSymbolByRef(IMarkerSymbol marker)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IMarkerLineSymbol

Symbol used for marker line.

Specified by:

setMarkerSymbolByRef in interface IMarkerLineSymbol

Parameters:

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

getColor

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

Description copied from interface: ILineSymbol

Line symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getColor in interface ILineSymbol

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

Line symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

setColor in interface ILineSymbol

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.

getWidth

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

Description copied from interface: ILineSymbol

Line symbol width.

Supported Platforms

Windows, Solaris, Linux

Description

Width returns or Sets the Double (ASCII) number in points.

Specified by:

getWidth in interface ILineSymbol

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(double width)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: ILineSymbol

Line symbol width.

Supported Platforms

Windows, Solaris, Linux

Description

Width returns the Double (ASCII) number in points.

Specified by:

setWidth in interface ILineSymbol

Parameters:

width - The width (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCap

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

Description copied from interface: ICartographicLineSymbol

Line end cap style.

Supported Platforms

Windows, Solaris, Linux

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Specified by:

getCap in interface ICartographicLineSymbol

Returns:

A com.esri.arcgis.display.esriLineCapStyle constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCap

public void setCap(int capStyle)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ICartographicLineSymbol

Line end cap style.

Supported Platforms

Windows, Solaris, Linux

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Specified by:

setCap in interface ICartographicLineSymbol

Parameters:

capStyle - A com.esri.arcgis.display.esriLineCapStyle constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getJoin

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

Description copied from interface: ICartographicLineSymbol

Line join style.

Supported Platforms

Windows, Solaris, Linux

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Specified by:

getJoin in interface ICartographicLineSymbol

Returns:

A com.esri.arcgis.display.esriLineJoinStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoin

public void setJoin(int joinStyle)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ICartographicLineSymbol

Line join style.

Supported Platforms

Windows, Solaris, Linux

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Specified by:

setJoin in interface ICartographicLineSymbol

Parameters:

joinStyle - A com.esri.arcgis.display.esriLineJoinStyle constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMiterLimit

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

Description copied from interface: ICartographicLineSymbol

Size threshold for showing mitered line joins.

Supported Platforms

Windows, Solaris, Linux

Remarks

Not yet implemented.

Specified by:

getMiterLimit in interface ICartographicLineSymbol

Returns:

The miterLimit

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMiterLimit

public void setMiterLimit(double miterLimit)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ICartographicLineSymbol

Size threshold for showing mitered line joins.

Supported Platforms

Windows, Solaris, Linux

Remarks

Not yet implemented.

Specified by:

setMiterLimit in interface ICartographicLineSymbol

Parameters:

miterLimit - The miterLimit (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.

getLineDecoration

public ILineDecoration getLineDecoration()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: ILineProperties

Line decoration element collection.

Supported Platforms

Windows, Solaris, Linux

Description

LineDecoration is the line decoration for the current ILineProperties .

Specified by:

getLineDecoration in interface ILineProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineDecorationByRef

public void setLineDecorationByRef(ILineDecoration lineDecoration)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ILineProperties

Line decoration element collection.

Specified by:

setLineDecorationByRef in interface ILineProperties

Parameters:

lineDecoration - A reference to a com.esri.arcgis.display.ILineDecoration (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDecorationOnTop

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

Description copied from interface: ILineProperties

Indicates if the decoration is drawn on top.

Supported Platforms

Windows, Solaris, Linux

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Specified by:

isDecorationOnTop in interface ILineProperties

Returns:

The onTop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDecorationOnTop

public void setDecorationOnTop(boolean onTop)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ILineProperties

Indicates if the decoration is drawn on top.

Supported Platforms

Windows, Solaris, Linux

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Specified by:

setDecorationOnTop in interface ILineProperties

Parameters:

onTop - The onTop (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFlip

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

Description copied from interface: ILineProperties

Indicates if the line symbol is flipped.

Supported Platforms

Windows, Solaris, Linux

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Specified by:

isFlip in interface ILineProperties

Returns:

The flip

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFlip

public void setFlip(boolean flip)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ILineProperties

Indicates if the line symbol is flipped.

Supported Platforms

Windows, Solaris, Linux

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Specified by:

setFlip in interface ILineProperties

Parameters:

flip - The flip (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getOffset

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

Description copied from interface: ILineProperties

The line offset value.

Supported Platforms

Windows, Solaris, Linux

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. the Offset can be a positive (above/left) or negative (below/right) number.

Specified by:

getOffset in interface ILineProperties

Returns:

The offset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ILineProperties

The line offset value.

Supported Platforms

Windows, Solaris, Linux

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. the Offset can be a positive (above/left) or negative (below/right) number.

Specified by:

setOffset in interface ILineProperties

Parameters:

offset - The offset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineStartOffset

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

Description copied from interface: ILineProperties

The line start offset.

Supported Platforms

Windows, Solaris, Linux

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

Specified by:

getLineStartOffset in interface ILineProperties

Returns:

The offset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLineStartOffset

public void setLineStartOffset(double offset)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ILineProperties

The line start offset.

Supported Platforms

Windows, Solaris, Linux

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

Specified by:

setLineStartOffset in interface ILineProperties

Parameters:

offset - The offset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTemplate

public ITemplate getTemplate()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ILineProperties

The line template.

Supported Platforms

Windows, Solaris, Linux

Description

Template is the template of marks and gaps.

Specified by:

getTemplate in interface ILineProperties

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTemplateByRef

public void setTemplateByRef(ITemplate theTemplate)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ILineProperties

The line template.

Specified by:

setTemplateByRef in interface ILineProperties

Parameters:

theTemplate - A reference to a com.esri.arcgis.display.ITemplate (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

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.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IDisplayName

The display name of an object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IDisplayName

Returns:

The displayName

Throws:

AutomationException - If the ArcObject component throws an exception.

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