org.opengis.go.display.primitive
Interface GraphicSymbol

All Superinterfaces:

Graphic

public interface GraphicSymbol

extends Graphic

The GraphicSymbol interface is used to draw a symbolic graphic on the canvas. A GraphicSymbol can be defined as a point, line, area, or other type of graphic. The symbology attributes of the graphic define how the graphic is rendered. The symbol can be a complex rendering or a simple rendering. Each graphic symbol defines 1 or more anchor points. These anchor points define special positional locations in the symbol. The required number, order and position of anchor points are dependent on what type of symbology you are using.

Method Summary

void	addAnchorPoint(DirectPosition anchor) Appends an anchor point to the end of the list of anchors.
void	deleteAnchorPoint(int index) Removes the anchor point located at the given index.
String	getActiveSymbology() Gets the active symbology name that is being used to render this graphic symbol.
DirectPosition	getAnchorPoint(int index) Gets an anchor point located at the given index.
PointArray	getAnchorPointArray() Gets the current list of anchor points for this graphic symbol.
DirectPosition[]	getAnchorPoints() Gets the current list of anchor points for this graphic symbol.
Symbology	getSymbology(String symbologyName) Gets the symbology settings object for the given symbology name.
String	getSymbologyVersion() Gets the active symbology name that is being used to render this graphic symbol.
void	insertAnchorPoint(int index, DirectPosition anchor) Inserts an anchor point at the given index.
void	setActiveSymbology(String symbologyName) Sets the active symbology name that is being used to render this graphic symbol.
void	setAnchorPoint(int index, DirectPosition anchor) Sets an anchor point at the given index.
void	setAnchorPointArray(PointArray pointArray) Sets the complete list of anchor points for this graphic symbol.
void	setAnchorPoints(DirectPosition[] anchors) Sets the complete list of anchor points for this graphic symbol.
void	setSymbologyVersion(String symbologyVersion) Sets the active symbology version that is being supported by this implementation.

Methods inherited from interface Graphic

addGraphicListener, cloneGraphic, dispose, fireGraphicEvent, getClientProperty, getGraphicStyle, getName, getParent, isPassingEventsToParent, isShowingAnchorHandles, isShowingEditHandles, putClientProperty, refresh, removeGraphicListener, setName, setParent, setPassingEventsToParent, setShowingAnchorHandles, setShowingEditHandles

Method Detail

addAnchorPoint

void addAnchorPoint(DirectPosition anchor)

Appends an anchor point to the end of the list of anchors. An anchor point is a point of interest in a graphic symbol that is used in creating the symbol.

Parameters:

anchor - the new position to add as an anchor point

deleteAnchorPoint

void deleteAnchorPoint(int index)
                       throws IndexOutOfBoundsException

Removes the anchor point located at the given index.

Parameters:

index - the index of the anchor point to remove.

Throws:

IndexOutOfBoundsException - if the index does not fall in the range of anchor points.

getAnchorPoint

DirectPosition getAnchorPoint(int index)
                              throws IndexOutOfBoundsException

Gets an anchor point located at the given index.

Parameters:

index - the index of the anchor point to get

Returns:

the anchor point position

Throws:

IndexOutOfBoundsException - if the index does not fall in the range of anchor points.

insertAnchorPoint

void insertAnchorPoint(int index,
                       DirectPosition anchor)
                       throws IndexOutOfBoundsException

Inserts an anchor point at the given index. All other anchor points at index and greater will increase in index location by one. The number of anchor points will increase by 1 as a result of this operation.

Parameters:

index - the index of where to insert the anchor point

anchor - the anchor point to insert

Throws:

IndexOutOfBoundsException - if the index does not fall in the range of anchor points.

setAnchorPoint

void setAnchorPoint(int index,
                    DirectPosition anchor)
                    throws IndexOutOfBoundsException

Sets an anchor point at the given index. The current anchor point that is located at the index will be replaced with the anchor point passed in. The number of anchor points will stay the same since no new points will be added

Parameters:

index - the index of where to set the anchor point

anchor - the anchor point to set

Throws:

IndexOutOfBoundsException - if the index does not fall in the range of anchor points.

setAnchorPoints

void setAnchorPoints(DirectPosition[] anchors)

Sets the complete list of anchor points for this graphic symbol. All existing anchor points will be removed as a result of this operation.

Parameters:

anchors - the new list of anchors

getAnchorPoints

DirectPosition[] getAnchorPoints()

Gets the current list of anchor points for this graphic symbol.

Returns:

the ordered list of anchor points

setAnchorPointArray

void setAnchorPointArray(PointArray pointArray)

Sets the complete list of anchor points for this graphic symbol. All existing anchor points will be removed as a result of this operation.

Parameters:

pointArray - the new list of anchors

getAnchorPointArray

PointArray getAnchorPointArray()

Gets the current list of anchor points for this graphic symbol.

Returns:

the ordered list of anchor points

getSymbology

Symbology getSymbology(String symbologyName)

Gets the symbology settings object for the given symbology name. If the symbology is not supported, it will return null.

Parameters:

symbologyName - the name of the symbology properties to get

Returns:

the Symbology instance to set properties on the requested type of symbology

getActiveSymbology

String getActiveSymbology()

Gets the active symbology name that is being used to render this graphic symbol. An active symbology will use the settings that were set on the Symbology object that will define how the graphic is displayed

Returns:

the active symbology name

setActiveSymbology

void setActiveSymbology(String symbologyName)
                        throws IllegalArgumentException

Sets the active symbology name that is being used to render this graphic symbol.

Parameters:

symbologyName - the new active symbology

Throws:

IllegalArgumentException - if the symbology isn't supported

getSymbologyVersion

String getSymbologyVersion()

Gets the active symbology name that is being used to render this graphic symbol. An active symbology will use the settings that were set on the Symbology object that will define how the graphic is displayed

Returns:

the active symbology version string

setSymbologyVersion

void setSymbologyVersion(String symbologyVersion)
                         throws IllegalArgumentException

Sets the active symbology version that is being supported by this implementation.

Parameters:

symbologyVersion - the symbology verion supported

Throws:

IllegalArgumentException - if the symbology doesn't support versions