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

Class SimpleLineStyle

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IStyle, ILineStyle, ISimpleLineStyle, Persistent

public class SimpleLineStyle
extends AbstractStyle
implements CartographicSupport, ISimpleLineStyle

See Also:

http://www.oreilly.com/catalog/java2d/chapter/ch04.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleLineStyle.RegisterPersistence

Field Summary

Fields

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

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

STYLE_PERSISTENCE_DEFINITION_NAME

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
SimpleLineStyle() Constructor method
SimpleLineStyle(float width, int cap, int join, float miterlimit, float[] dash, float dash_phase) Constructor method

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
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.
IArrowDecoratorStyle	getArrowDecorator() Gets the arrow decorator style that has the line
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
java.lang.String	getClassName()
float	getLineWidth() Returns the width of the line
double	getOffset() Returns the offset of the line
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
java.awt.Stroke	getStroke() Returns the stroke of the line
int	getUnit() Returns the unit used to express measures.
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	setArrowDecorator(IArrowDecoratorStyle arrowDecoratorStyle) Sets the arrow decorator style of the line
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setLineWidth(float width) Establishes the width of the line
void	setOffset(double offset) Establishes the offset of the line
void	setReferenceSystem(int referenceSystem) Sets the Reference System that defines how this units have to be handled.
void	setStroke(java.awt.Stroke stroke) Sets the stroke of the line
void	setUnit(int unitIndex) Defines the unit used to express measures.
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

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

getDescription, setDescription

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

Field Detail

SIMPLE_LINE_STYLE_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SIMPLE_LINE_STYLE_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleLineStyle

public SimpleLineStyle()

Constructor method

SimpleLineStyle

public SimpleLineStyle(float width,
               int cap,
               int join,
               float miterlimit,
               float[] dash,
               float dash_phase)

Constructor method

Parameters:

width -

cap -

join -

miterlimit -

dash -

dash_phase -

Method Detail

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

getClassName

public java.lang.String getClassName()

getStroke

public java.awt.Stroke getStroke()

Description copied from interface: ILineStyle

Returns the stroke of the line

Specified by:

getStroke in interface ILineStyle

Returns:

Stroke of the line

getLineWidth

public float getLineWidth()

Description copied from interface: ILineStyle

Returns the width of the line

Specified by:

getLineWidth in interface ILineStyle

Returns:

setLineWidth

public void setLineWidth(float width)

Description copied from interface: ILineStyle

Establishes the width of the line

Specified by:

setLineWidth in interface ILineStyle

Parameters:

width - of the line

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

setStroke

public void setStroke(java.awt.Stroke stroke)

Description copied from interface: ILineStyle

Sets the stroke of the line

Specified by:

setStroke in interface ILineStyle

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

getOffset

public double getOffset()

Description copied from interface: ILineStyle

Returns the offset of the line

Specified by:

getOffset in interface ILineStyle

Returns:

setOffset

public void setOffset(double offset)

Description copied from interface: ILineStyle

Establishes the offset of the line

Specified by:

setOffset in interface ILineStyle

getArrowDecorator

public IArrowDecoratorStyle getArrowDecorator()

Description copied from interface: ILineStyle

Gets the arrow decorator style that has the line

Specified by:

getArrowDecorator in interface ILineStyle

Returns:

ArrowDecoratorStyle

setArrowDecorator

public void setArrowDecorator(IArrowDecoratorStyle arrowDecoratorStyle)

Description copied from interface: ILineStyle

Sets the arrow decorator style of the line

Specified by:

setArrowDecorator in interface ILineStyle

setUnit

public void setUnit(int unitIndex)

Description copied from interface: CartographicSupport

Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

setUnit in interface CartographicSupport

getUnit

public int getUnit()

Description copied from interface: CartographicSupport

Returns the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

getUnit in interface CartographicSupport

getReferenceSystem

public int getReferenceSystem()

Description copied from interface: CartographicSupport

Returns the Reference System used to draw the elements of the image.

The elements have to be scaled to pixel when the image is bein drawn in order to compose the map. The elements of the map may define its size in other units than pixel.

CartographicSupport enables the elements to define the size in measure units but these units may refer to different reference system. Two kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD, and CartographicSupport.PAPER.

Depending on which Reference System is used the unit used by this element refers to distances in the real world (then they are map's CRS-dependant) or screen or printer output (then they are output DPI-dependant)

In case the unit used is pixel then the reference system does not have any effect since the source unit is the same than the target unit.

Specified by:

getReferenceSystem in interface CartographicSupport

Returns:

setReferenceSystem

public void setReferenceSystem(int referenceSystem)

Description copied from interface: CartographicSupport

Sets the Reference System that defines how this units have to be handled. Possible values are:

1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).

Specified by:

setReferenceSystem in interface CartographicSupport

toCartographicSize

public double toCartographicSize(ViewPort viewPort,
                        double dpi,
                        Geometry geom)

Description copied from interface: CartographicSupport

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

setCartographicSize

public void setCartographicSize(double cartographicSize,
                       Geometry geom)

Description copied from interface: CartographicSupport

Sets the size of the cartographic element in pixels.

Specified by:

setCartographicSize in interface CartographicSupport

getCartographicSize

public double getCartographicSize(ViewPort viewPort,
                         double dpi,
                         Geometry geom)

Description copied from interface: CartographicSupport

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

double containing the size in [screen/printer] pixels for the current symbol

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