org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style

Class ArrowDecoratorStyle

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.ArrowDecoratorStyle

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IStyle, IArrowDecoratorStyle, Persistent

public class ArrowDecoratorStyle
extends AbstractStyle
implements IArrowDecoratorStyle

Class ArrowDecoratorStyle. It is used to store the information about the different options to draw an arrow in a line (and draw it too). This information is taken from the panel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrowDecoratorStyle.RegisterPersistence

Nested classes/interfaces inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

CartographicSupport.CartographicContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARROR_DECORATOR_STYLE_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

LOGGER, STYLE_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
ArrowDecoratorStyle()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature feature) Draws an arrow(or other symbol that substitutes an arrow selected by the user) in a line.When the line is drawn, the symbol is added and takes care of the different options of the user(for example if he wants to flip the first symbol or all and the number of symbols per line to be drawn)
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
void	drawOutline(java.awt.Graphics2D g, java.awt.Rectangle r) Used to show an outline of the style to graphically show its properties.
int	getArrowMarkerCount() Obtains the number of arrows that the user wants to draw in the same line.
java.lang.String	getClassName()
IMarkerSymbol	getMarker()
boolean	isFlipAll() Defines the flipAll attribute.If the value of this attribute is true all the arrows that we had drawn in the same line will be flipped.
boolean	isFlipFirst() Obtains the flipFirst attribute.If it is true only the first arrow of the line will be flipped.The rest will keep the same orientation.
boolean	isFollowLineAngle() Gets the followLineAngle attribute.This attribute allows the arrow that we are going to draw to be more or less aligned with the line where it will be included (depending on the angle) .
boolean	isSuitableFor(ISymbol symbol) True if this symbol is ok for the style or class.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setArrowMarkerCount(int arrowMarkerCount) Defines the number of arrows that the user wants to draw in the same line.
void	setCartographicContext(CartographicSupport.CartographicContext ctx)
void	setFlipAll(boolean flipAll) Obtains the flipAll attribute.If the value of this attribute is true all the arrows that we had drawn in the same line will be flipped.
void	setFlipFirst(boolean flipFirst) Sets the flipFirst attribute.If it is true only the first arrow of the line will be flipped.The rest will keep the same orientation.
void	setFollowLineAngle(boolean followLineAngle) Sets the followLineAngle attribute.This attribute allows the arrow that we are going to draw to be more or less aligned with the line where it will be included.
void	setMarker(IMarkerSymbol marker)

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

getDescription, setDescription

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, isInPixels, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, toCartographicUnits

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.styles.IStyle

getDescription, setDescription

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

copyCartographicContext

Field Detail

ARROR_DECORATOR_STYLE_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String ARROR_DECORATOR_STYLE_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

ArrowDecoratorStyle

public ArrowDecoratorStyle()

Method Detail

getArrowMarkerCount

public int getArrowMarkerCount()

Obtains the number of arrows that the user wants to draw in the same line.

Specified by:

getArrowMarkerCount in interface IArrowDecoratorStyle

Returns:

setArrowMarkerCount

public void setArrowMarkerCount(int arrowMarkerCount)

Defines the number of arrows that the user wants to draw in the same line.

Specified by:

setArrowMarkerCount in interface IArrowDecoratorStyle

isFlipAll

public boolean isFlipAll()

Defines the flipAll attribute.If the value of this attribute is true all the arrows that we had drawn in the same line will be flipped.

Specified by:

isFlipAll in interface IArrowDecoratorStyle

Returns:

setFlipAll

public void setFlipAll(boolean flipAll)

Obtains the flipAll attribute.If the value of this attribute is true all the arrows that we had drawn in the same line will be flipped.

Specified by:

setFlipAll in interface IArrowDecoratorStyle

isFlipFirst

public boolean isFlipFirst()

Obtains the flipFirst attribute.If it is true only the first arrow of the line will be flipped.The rest will keep the same orientation.

Specified by:

isFlipFirst in interface IArrowDecoratorStyle

Returns:

setFlipFirst

public void setFlipFirst(boolean flipFirst)

Sets the flipFirst attribute.If it is true only the first arrow of the line will be flipped.The rest will keep the same orientation.

Specified by:

setFlipFirst in interface IArrowDecoratorStyle

isFollowLineAngle

public boolean isFollowLineAngle()

Gets the followLineAngle attribute.This attribute allows the arrow that we are going to draw to be more or less aligned with the line where it will be included (depending on the angle) .

Specified by:

isFollowLineAngle in interface IArrowDecoratorStyle

Returns:

setFollowLineAngle

public void setFollowLineAngle(boolean followLineAngle)

Sets the followLineAngle attribute.This attribute allows the arrow that we are going to draw to be more or less aligned with the line where it will be included. (depending on the angle).

Specified by:

setFollowLineAngle in interface IArrowDecoratorStyle

Parameters:

followingLineAngle -

draw

public void draw(java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform affineTransform,
                 Geometry geom,
                 Feature feature)
          throws CreateGeometryException

Draws an arrow(or other symbol that substitutes an arrow selected by the user) in a line.When the line is drawn, the symbol is added and takes care of the different options of the user(for example if he wants to flip the first symbol or all and the number of symbols per line to be drawn)

Specified by:

draw in interface IArrowDecoratorStyle

Parameters:

g -

affineTransform -

feature -

shp -

Throws:

CreateGeometryException

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D g,
                                java.awt.Rectangle r)

Description copied from interface: IStyle

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course. You may also preffer to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface IStyle

Parameters:

g - Graphics2D

r - Rectangle

drawOutline

public void drawOutline(java.awt.Graphics2D g,
                        java.awt.Rectangle r)

Description copied from interface: IStyle

Used to show an outline of the style to graphically show its properties.

Specified by:

drawOutline in interface IStyle

isSuitableFor

public boolean isSuitableFor(ISymbol symbol)

Description copied from interface: IStyle

True if this symbol is ok for the style or class.

Specified by:

isSuitableFor in interface IStyle

Parameters:

symbol - ISymbol

getClassName

public java.lang.String getClassName()

getMarker

public IMarkerSymbol getMarker()

Specified by:

getMarker in interface IArrowDecoratorStyle

setMarker

public void setMarker(IMarkerSymbol marker)

Specified by:

setMarker in interface IArrowDecoratorStyle

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractStyle

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractStyle

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractStyle

Throws:

PersistenceException

setCartographicContext

public void setCartographicContext(CartographicSupport.CartographicContext ctx)

Specified by:

setCartographicContext in interface CartographicSupport

Overrides:

setCartographicContext in class AbstractCartographicSupport