com.esri.arcgis.display
Class SimpleLineDecorationElement

java.lang.Object
  extended by com.esri.arcgis.display.SimpleLineDecorationElement
All Implemented Interfaces:
IDisplayName, ILineDecorationElement, ISimpleLineDecorationElement, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class SimpleLineDecorationElement
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISimpleLineDecorationElement, ILineDecorationElement, IPersistStream, IPersist, IClone, IDisplayName, Externalizable

Simple Line Decoration Element.

Description

SimpleLineDecorationElement is a way of specifying a marker symbol to be used as a decoration element for a line symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
SimpleLineDecorationElement()
          Constructs a SimpleLineDecorationElement using ArcGIS Engine.
SimpleLineDecorationElement(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SimpleLineDecorationElement theSimpleLineDecorationElement = (SimpleLineDecorationElement) obj;
 
Method Summary
 void addPosition(double elementPosition)
          Adds a position.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clearPositions()
          Clears all positions.
 void deletePosition(int index)
          Deletes a position.
 void draw(int hDC, ITransformation transform, IGeometry lineGeometry)
          Draws the given line geometry.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IMarkerSymbol getMarkerSymbol()
          The marker symbol.
 String getNameString()
          The display name of an object.
 double getPosition(int index)
          The element position at the given index.
 int getPositionCount()
          The number of positions.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isFlipAll()
          Indicates if all symbols are flipped 180 degrees.
 boolean isFlipFirst()
          Indicates if marker symbol in '0' position is flipped 180 degrees.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isPositionAsRatio()
          Indicates if positions represent percentage or absolute distance along the line.
 boolean isRotate()
          Indicates if marker symbols are rotated to follow the line.
 void load(IStream pstm)
          load
 void queryBoundary(int hDC, ITransformation transform, IGeometry lineGeometry, IPolygon boundary)
          Queries for the boundary of a given line geometry.
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setFlipAll(boolean flipAll)
          Indicates if all symbols are flipped 180 degrees.
 void setFlipFirst(boolean flipFirst)
          Indicates if marker symbol in '0' position is flipped 180 degrees.
 void setMarkerSymbol(IMarkerSymbol markerSymbol)
          The marker symbol.
 void setPositionAsRatio(boolean asRatio)
          Indicates if positions represent percentage or absolute distance along the line.
 void setRotate(boolean rotate)
          Indicates if marker symbols are rotated to follow the line.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

SimpleLineDecorationElement

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

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

SimpleLineDecorationElement

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

Construct a SimpleLineDecorationElement using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SimpleLineDecorationElement.

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

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException
The marker symbol.

Description

MarkerSymbol is the marker symbol for the ISimpleLineDecorationElement interface. This can be any marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarkerSymbol

public void setMarkerSymbol(IMarkerSymbol markerSymbol)
                     throws IOException,
                            AutomationException
The marker symbol.

Description

MarkerSymbol is the marker symbol for the ISimpleLineDecorationElement interface. This can be any marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isRotate

public boolean isRotate()
                 throws IOException,
                        AutomationException
Indicates if marker symbols are rotated to follow the line.

Description

Rotate is whether the marker symbol will rotate with the slope of the line when drawn (true), or always draw at the same angle (false).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRotate in interface ISimpleLineDecorationElement
Returns:
The rotate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotate

public void setRotate(boolean rotate)
               throws IOException,
                      AutomationException
Indicates if marker symbols are rotated to follow the line.

Description

Rotate is whether the marker symbol will rotate with the slope of the line when drawn (true), or always draw at the same angle (false).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFlipFirst

public boolean isFlipFirst()
                    throws IOException,
                           AutomationException
Indicates if marker symbol in '0' position is flipped 180 degrees.

Description

FlipFirst is whether the directionality of the first symbol in the ISimpleLineDecorationElement is reversed (true). If false (default), then the marker appears as normal.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFlipFirst in interface ISimpleLineDecorationElement
Returns:
The flipFirst
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlipFirst

public void setFlipFirst(boolean flipFirst)
                  throws IOException,
                         AutomationException
Indicates if marker symbol in '0' position is flipped 180 degrees.

Description

FlipFirst is whether the directionality of the first symbol in the ISimpleLineDecorationElement is reversed (true). If false (default), then the marker appears as normal.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFlipAll

public boolean isFlipAll()
                  throws IOException,
                         AutomationException
Indicates if all symbols are flipped 180 degrees.

Description

FlipAll is whether the directionality of all positions of the marker symbol in the ISimpleLineDecorationElement are reversed (true). If false (default), then the they appear as normal.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFlipAll in interface ISimpleLineDecorationElement
Returns:
The flipAll
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlipAll

public void setFlipAll(boolean flipAll)
                throws IOException,
                       AutomationException
Indicates if all symbols are flipped 180 degrees.

Description

FlipAll is whether the directionality of all positions of the marker symbol in the ISimpleLineDecorationElement are reversed (true). If false (default), then the they appear as normal.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addPosition

public void addPosition(double elementPosition)
                 throws IOException,
                        AutomationException
Adds a position.

Description

AddPosition adds a position where the line decoration element will be drawn. Values between 0 and 1 are valid. 0 indicates the beginning of the line and 1 indicates the end. Intervening values, like 0.25 indicate the percentage along the line that the decoration element will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deletePosition

public void deletePosition(int index)
                    throws IOException,
                           AutomationException
Deletes a position.

Description

DeletePosition removes the decoration at the given index from the list of positions the decoration element will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clearPositions

public void clearPositions()
                    throws IOException,
                           AutomationException
Clears all positions.

Description

ClearPositions removes any positions that have been added to the ILineDecorationElement object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isPositionAsRatio

public boolean isPositionAsRatio()
                          throws IOException,
                                 AutomationException
Indicates if positions represent percentage or absolute distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPositionAsRatio in interface ILineDecorationElement
Returns:
The asRatio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPositionAsRatio

public void setPositionAsRatio(boolean asRatio)
                        throws IOException,
                               AutomationException
Indicates if positions represent percentage or absolute distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPosition

public double getPosition(int index)
                   throws IOException,
                          AutomationException
The element position at the given index.

Product Availability

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

Specified by:
getPosition in interface ILineDecorationElement
Parameters:
index - The index (in)
Returns:
The elementPos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPositionCount

public int getPositionCount()
                     throws IOException,
                            AutomationException
The number of positions.

Description

PositionCount returns the number of positions that have been set for the ILineDecorationElement object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPositionCount in interface ILineDecorationElement
Returns:
The positionCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation transform,
                          IGeometry lineGeometry,
                          IPolygon boundary)
                   throws IOException,
                          AutomationException
Queries for the boundary of a given line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryBoundary in interface ILineDecorationElement
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
lineGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int hDC,
                 ITransformation transform,
                 IGeometry lineGeometry)
          throws IOException,
                 AutomationException
Draws the given line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ILineDecorationElement
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
lineGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

load

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

save

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSizeMax

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassID

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

esri_clone

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

Product Availability

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

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

assign

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

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException
The display name of an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNameString in interface IDisplayName
Returns:
The displayName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

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

readExternal

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