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

Class SimpleLabelStyle

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.SimpleLabelStyle

All Implemented Interfaces:

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

public class SimpleLabelStyle
extends AbstractStyle
implements ILabelStyle

Implements a style for the creation of simple labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleLabelStyle.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	SIMPLE_LABEL_STYLE_PERSISTENCE_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
SimpleLabelStyle()

Method Summary

Modifier and Type	Method and Description
void	addTextFieldArea(java.awt.geom.Rectangle2D rect) Adds a new TextFieldArea with an specific size which is defined as a rectangle.
void	deleteTextFieldArea(int index) Delete the TextFieldArea specified by its index.
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.
IBackgroundFileStyle	getBackgroundFileStyle()
java.lang.String	getClassName()
int	getFieldCount()
java.awt.geom.Point2D	getMarkerPoint() Returns the position of the point labeled by this label in percent units relative to the label bounds.
java.awt.Dimension	getSize()
java.awt.geom.Rectangle2D[]	getTextBounds() Returns an array of rectangles defining the text boxes where text is placed.
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	setBackgroundFileStyle(IBackgroundFileStyle bg)
void	setMarkerPoint(java.awt.geom.Point2D p) Sets the position of the point labeled by this in percent units relative to the label bounds
void	setSize(double width, double height) Sets the size for a laber and stablishes an unit scale factor to not change too much its content
void	setTextFieldArea(int index, java.awt.geom.Rectangle2D rect) Sets a TextFieldArea using its index.
void	setTextFields(java.lang.String[] texts) Sets the texts that will appear in the label.

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

clone, getDescription, setDescription

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

copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, isInPixels, setCartographicContext, 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

clone, cloneQuietly, cloneQuietly

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

copyCartographicContext

Field Detail

SIMPLE_LABEL_STYLE_PERSISTENCE_NAME

public static final java.lang.String SIMPLE_LABEL_STYLE_PERSISTENCE_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleLabelStyle

public SimpleLabelStyle()

Method Detail

getFieldCount

public int getFieldCount()

Specified by:

getFieldCount in interface ILabelStyle

Returns:

int, the amount of fields this style allows

setTextFields

public void setTextFields(java.lang.String[] texts)

Description copied from interface: ILabelStyle

Sets the texts that will appear in the label.

Specified by:

setTextFields in interface ILabelStyle

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()

getTextBounds

public java.awt.geom.Rectangle2D[] getTextBounds()

Description copied from interface: ILabelStyle

Returns an array of rectangles defining the text boxes where text is placed.

Specified by:

getTextBounds in interface ILabelStyle

Returns:

drawInsideRectangle

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

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

Throws:

SymbolDrawingException

getSize

public java.awt.Dimension getSize()

Specified by:

getSize in interface ILabelStyle

getMarkerPoint

public java.awt.geom.Point2D getMarkerPoint()

Description copied from interface: ILabelStyle

Returns the position of the point labeled by this label in percent units relative to the label bounds. It determines the offset to be applied to the label to be placed and allows the user to use custom styles.

Specified by:

getMarkerPoint in interface ILabelStyle

setMarkerPoint

public void setMarkerPoint(java.awt.geom.Point2D p)
                    throws java.lang.IllegalArgumentException

Description copied from interface: ILabelStyle

Sets the position of the point labeled by this in percent units relative to the label bounds

Specified by:

setMarkerPoint in interface ILabelStyle

Throws:

java.lang.IllegalArgumentException - if the point coordinates are >0.0 or <1.0

drawOutline

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

Description copied from interface: IStyle

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

Specified by:

drawOutline in interface IStyle

Throws:

SymbolDrawingException

setTextFieldArea

public void setTextFieldArea(int index,
                             java.awt.geom.Rectangle2D rect)

Description copied from interface: ILabelStyle

Sets a TextFieldArea using its index. With this method the user can modify the size of the rectangle for the TextFieldArea

Specified by:

setTextFieldArea in interface ILabelStyle

addTextFieldArea

public void addTextFieldArea(java.awt.geom.Rectangle2D rect)

Description copied from interface: ILabelStyle

Adds a new TextFieldArea with an specific size which is defined as a rectangle.

Specified by:

addTextFieldArea in interface ILabelStyle

deleteTextFieldArea

public void deleteTextFieldArea(int index)

Description copied from interface: ILabelStyle

Delete the TextFieldArea specified by its index.

Specified by:

deleteTextFieldArea in interface ILabelStyle

setSize

public void setSize(double width,
                    double height)

Description copied from interface: ILabelStyle

Sets the size for a laber and stablishes an unit scale factor to not change too much its content

Specified by:

setSize in interface ILabelStyle

getBackgroundFileStyle

public IBackgroundFileStyle getBackgroundFileStyle()

Specified by:

getBackgroundFileStyle in interface ILabelStyle

setBackgroundFileStyle

public void setBackgroundFileStyle(IBackgroundFileStyle bg)

Specified by:

setBackgroundFileStyle in interface ILabelStyle

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