com.esri.arcgis.display
Interface ISimpleLineDecorationElement

All Superinterfaces:

ILineDecorationElement, Serializable

All Known Implementing Classes:

SimpleLineDecorationElement

public interface ISimpleLineDecorationElement
extends ILineDecorationElement, Serializable

Provides access to members that control the simple line decoration.

Description

ISimpleLineDecorationElement is a way of specifying a marker symbol to be used as a decoration element. See the ILineDecorationElement interface for the generic decoration element properties. With the ISimpleLineDecorationElement you have the ability to set whether the marker symbol rotates with the slope of the line as it is drawn, and whether the marker symbols are flipped (mirror flipped, so if they are arrow heads, you can change their direction).

Product Availability

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

Method Summary

IMarkerSymbol	getMarkerSymbol() The marker symbol.
boolean	isFlipAll() Indicates if all symbols are flipped 180 degrees.
boolean	isFlipFirst() Indicates if marker symbol in '0' position is flipped 180 degrees.
boolean	isRotate() Indicates if marker symbols are rotated to follow the line.
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	setRotate(boolean rotate) Indicates if marker symbols are rotated to follow the line.

Methods inherited from interface com.esri.arcgis.display.ILineDecorationElement

addPosition, clearPositions, deletePosition, draw, getPosition, getPositionCount, isPositionAsRatio, queryBoundary, setPositionAsRatio

Method Detail

getMarkerSymbol

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

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

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

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

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

Returns:

The rotate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotate

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

Parameters:

rotate - The rotate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlipFirst

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

Returns:

The flipFirst

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipFirst

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

Parameters:

flipFirst - The flipFirst (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlipAll

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

Returns:

The flipAll

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAll

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

Parameters:

flipAll - The flipAll (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.