org.gvsig.labeling.placements

Class PointLabelPositioner

java.lang.Object

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

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

org.gvsig.labeling.placements.PointLabelPositioner

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IStyle, Persistent

public class PointLabelPositioner
extends AbstractStyle

Specifies the point position for a label

Nested Class Summary

Nested classes/interfaces inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

AbstractStyle.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 byte	FORBIDDEN
static java.lang.String	POINT_LABEL_POSITIONER_PERSISTENCE_NAME
static byte	PREFERENCE_HIGH
static byte	PREFERENCE_LOW
static byte	PREFERENCE_NORMAL

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
PointLabelPositioner() Constructor method
PointLabelPositioner(int[] preferenceVector, java.lang.String description) Constructor method

Method Summary

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.
int[]	getPreferenceVector()
boolean	isSuitableFor(ISymbol sym) 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.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.

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, 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.tools.lang.Cloneable

cloneQuietly, cloneQuietly

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

copyCartographicContext

Field Detail

POINT_LABEL_POSITIONER_PERSISTENCE_NAME

public static final java.lang.String POINT_LABEL_POSITIONER_PERSISTENCE_NAME

See Also:

Constant Field Values

FORBIDDEN

public static final byte FORBIDDEN

See Also:

Constant Field Values

PREFERENCE_HIGH

public static final byte PREFERENCE_HIGH

See Also:

Constant Field Values

PREFERENCE_NORMAL

public static final byte PREFERENCE_NORMAL

See Also:

Constant Field Values

PREFERENCE_LOW

public static final byte PREFERENCE_LOW

See Also:

Constant Field Values

Constructor Detail

PointLabelPositioner

public PointLabelPositioner()

Constructor method

PointLabelPositioner

public PointLabelPositioner(int[] preferenceVector,
                            java.lang.String description)

Constructor method

Parameters:

preferenceVector -

description -

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.

Parameters:

g - Graphics2D

r - Rectangle

isSuitableFor

public boolean isSuitableFor(ISymbol sym)

Description copied from interface: IStyle

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

Parameters:

sym - ISymbol

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

registerPersistent

public static void registerPersistent()

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

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.

getPreferenceVector

public int[] getPreferenceVector()