com.vividsolutions.jump.workbench.ui.renderer.style
Class LabelStyle

java.lang.Object
  com.vividsolutions.jump.workbench.ui.renderer.style.LabelStyle

All Implemented Interfaces:

Style, java.lang.Cloneable

public class LabelStyle
extends java.lang.Object
implements Style

Field Summary

static java.lang.String	ABOVE_LINE
static java.lang.String	ABOVE_TEXT
static java.lang.String	BELOW_LINE
static java.lang.String	BELOW_TEXT
static java.lang.String	CENTER
static java.lang.String	CENTER_TEXT
static java.lang.String	DEFAULT
static java.lang.String	DEFAULT_TEXT
static java.lang.String	FID_COLUMN
static int	FONT_BASE_SIZE
java.lang.String	horizontalPosition
static java.lang.String[]	horizontalPositionLookup
static int	JUSTIFY_CENTER
static java.lang.String	JUSTIFY_CENTER_TEXT
static int	JUSTIFY_LEFT
static java.lang.String	JUSTIFY_LEFT_TEXT
static int	JUSTIFY_RIGHT
static java.lang.String	JUSTIFY_RIGHT_TEXT
static java.lang.String	LEFT_SIDE
static java.lang.String	LEFT_SIDE_TEXT
static java.lang.String	MIDDLE_TEXT
static java.lang.String	ON_LINE
static java.lang.String	RIGHT_SIDE
static java.lang.String	RIGHT_SIDE_TEXT
java.lang.String	verticalAlignment
static java.lang.String[]	verticalAlignmentLookup

Constructor Summary

LabelStyle()

Method Summary

static double	angle(Feature feature, java.lang.String angleAttributeName, double defaultAngle)
java.lang.Object	clone()
com.vividsolutions.jts.geom.Coordinate	findPoint(com.vividsolutions.jts.geom.Geometry geometry) Find a point at upper-left, upper-center, upper-right, center-left, center, center-right, lower-left, lower-center or lower-right of the geometry envelope.
java.lang.String	getAngleAttribute()
java.lang.String	getAttribute()
java.awt.Color	getColor()
java.awt.Font	getFont()
double	getHeight()
java.lang.String	getHeightAttribute()
boolean	getHideAtScale()
boolean	getHidingOverlappingLabels()
int	getHorizontalAlignment()
double	getHorizontalAlignmentOffset(java.lang.String text)
java.lang.String	getHorizontalPosition()
java.awt.Color	getOutlineColor()
boolean	getOutlineShowing()
double	getOutlineWidth()
double	getScaleToHideAt()
java.lang.String	getVerticalAlignment()
double	getVerticalAlignmentOffset(int dim)
static double	height(Feature feature, java.lang.String heightAttributeName, double defaultHeight)
void	initialize(Layer layer) Called before #paint is applied to each Feature.
boolean	isEnabled()
boolean	isHidingAtScale()
boolean	isHidingOverlappingLabels()
boolean	isScaling()
void	paint(Feature f, java.awt.Graphics2D g, Viewport viewport)
void	paint(java.awt.Graphics2D g, java.lang.String text, Viewport viewport, java.awt.geom.Point2D viewCentre, double angle, double height, int dim)
void	setAngleAttribute(java.lang.String angleAttribute)
void	setAttribute(java.lang.String attribute)
void	setColor(java.awt.Color color)
void	setEnabled(boolean enabled)
void	setFont(java.awt.Font font)
void	setHeight(double height)
void	setHeightAttribute(java.lang.String heightAttribute)
void	setHideAtScale(boolean hideAtScale)
void	setHidingOverlappingLabels(boolean hidingOverlappingLabels)
void	setHorizontalAlignment(int horizontalAlignment)
void	setHorizontalPosition(java.lang.String horizontalPosition)
void	setOutlineColor(java.awt.Color outlineColor)
void	setOutlineColor(java.awt.Color outlineColor, int alpha)
void	setOutlineShowing(boolean outlineShowing)
void	setOutlineWidth(double outlineWidth)
void	setScaleToHideAt(double scaleToHideAt)
void	setScaling(boolean scaling)
void	setVerticalAlignment(java.lang.String verticalAlignment)

Methods inherited from class java.lang.Object

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

Field Detail

FONT_BASE_SIZE

public static final int FONT_BASE_SIZE

See Also:

Constant Field Values

FID_COLUMN

public static final java.lang.String FID_COLUMN

See Also:

Constant Field Values

ABOVE_LINE

public static final java.lang.String ABOVE_LINE

See Also:

Constant Field Values

ON_LINE

public static final java.lang.String ON_LINE

See Also:

Constant Field Values

BELOW_LINE

public static final java.lang.String BELOW_LINE

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

verticalAlignmentLookup

public static final java.lang.String[] verticalAlignmentLookup

LEFT_SIDE

public static final java.lang.String LEFT_SIDE

See Also:

Constant Field Values

CENTER

public static final java.lang.String CENTER

See Also:

Constant Field Values

RIGHT_SIDE

public static final java.lang.String RIGHT_SIDE

See Also:

Constant Field Values

horizontalPositionLookup

public static final java.lang.String[] horizontalPositionLookup

DEFAULT_TEXT

public static java.lang.String DEFAULT_TEXT

ABOVE_TEXT

public static java.lang.String ABOVE_TEXT

MIDDLE_TEXT

public static java.lang.String MIDDLE_TEXT

BELOW_TEXT

public static java.lang.String BELOW_TEXT

LEFT_SIDE_TEXT

public static final java.lang.String LEFT_SIDE_TEXT

CENTER_TEXT

public static final java.lang.String CENTER_TEXT

RIGHT_SIDE_TEXT

public static final java.lang.String RIGHT_SIDE_TEXT

JUSTIFY_CENTER_TEXT

public static final java.lang.String JUSTIFY_CENTER_TEXT

JUSTIFY_LEFT_TEXT

public static final java.lang.String JUSTIFY_LEFT_TEXT

JUSTIFY_RIGHT_TEXT

public static final java.lang.String JUSTIFY_RIGHT_TEXT

JUSTIFY_CENTER

public static final int JUSTIFY_CENTER

See Also:

Constant Field Values

JUSTIFY_LEFT

public static final int JUSTIFY_LEFT

See Also:

Constant Field Values

JUSTIFY_RIGHT

public static final int JUSTIFY_RIGHT

See Also:

Constant Field Values

verticalAlignment

public java.lang.String verticalAlignment

horizontalPosition

public java.lang.String horizontalPosition

Constructor Detail

LabelStyle

public LabelStyle()

Method Detail

initialize

public void initialize(Layer layer)

Description copied from interface: Style

Called before #paint is applied to each Feature.

Specified by:

initialize in interface Style

paint

public void paint(Feature f,
                  java.awt.Graphics2D g,
                  Viewport viewport)
           throws java.awt.geom.NoninvertibleTransformException

Specified by:

paint in interface Style

Throws:

java.awt.geom.NoninvertibleTransformException

angle

public static double angle(Feature feature,
                           java.lang.String angleAttributeName,
                           double defaultAngle)

findPoint

public com.vividsolutions.jts.geom.Coordinate findPoint(com.vividsolutions.jts.geom.Geometry geometry)

Find a point at upper-left, upper-center, upper-right, center-left, center, center-right, lower-left, lower-center or lower-right of the geometry envelope.

height

public static double height(Feature feature,
                            java.lang.String heightAttributeName,
                            double defaultHeight)

paint

public void paint(java.awt.Graphics2D g,
                  java.lang.String text,
                  Viewport viewport,
                  java.awt.geom.Point2D viewCentre,
                  double angle,
                  double height,
                  int dim)

getVerticalAlignmentOffset

public double getVerticalAlignmentOffset(int dim)

Returns:

approximate alignment offset for estimation

getHorizontalAlignmentOffset

public double getHorizontalAlignmentOffset(java.lang.String text)

Returns:

approximate alignment offset for estimation

getAttribute

public java.lang.String getAttribute()

getAngleAttribute

public java.lang.String getAngleAttribute()

getHeightAttribute

public java.lang.String getHeightAttribute()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Style

Returns:

false if #paint should not be called e.g. because vertices are not shown. Don't need to check whether the layer is visible.

getColor

public java.awt.Color getColor()

getFont

public java.awt.Font getFont()

isScaling

public boolean isScaling()

getHeight

public double getHeight()

isHidingOverlappingLabels

public boolean isHidingOverlappingLabels()

isHidingAtScale

public boolean isHidingAtScale()

getHideAtScale

public boolean getHideAtScale()

getVerticalAlignment

public java.lang.String getVerticalAlignment()

getHorizontalPosition

public java.lang.String getHorizontalPosition()

getHorizontalAlignment

public int getHorizontalAlignment()

getHidingOverlappingLabels

public boolean getHidingOverlappingLabels()

getOutlineShowing

public boolean getOutlineShowing()

getOutlineWidth

public double getOutlineWidth()

getScaleToHideAt

public double getScaleToHideAt()

getOutlineColor

public java.awt.Color getOutlineColor()

setVerticalAlignment

public void setVerticalAlignment(java.lang.String verticalAlignment)

setHorizontalPosition

public void setHorizontalPosition(java.lang.String horizontalPosition)

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)

setAttribute

public void setAttribute(java.lang.String attribute)

setAngleAttribute

public void setAngleAttribute(java.lang.String angleAttribute)

setHeightAttribute

public void setHeightAttribute(java.lang.String heightAttribute)

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Style

setColor

public void setColor(java.awt.Color color)

setFont

public void setFont(java.awt.Font font)

setScaling

public void setScaling(boolean scaling)

setHeight

public void setHeight(double height)

setHidingOverlappingLabels

public void setHidingOverlappingLabels(boolean hidingOverlappingLabels)

setOutlineShowing

public void setOutlineShowing(boolean outlineShowing)

setOutlineWidth

public void setOutlineWidth(double outlineWidth)

setScaleToHideAt

public void setScaleToHideAt(double scaleToHideAt)

setOutlineColor

public void setOutlineColor(java.awt.Color outlineColor,
                            int alpha)

setOutlineColor

public void setOutlineColor(java.awt.Color outlineColor)

setHideAtScale

public void setHideAtScale(boolean hideAtScale)

clone

public java.lang.Object clone()

Specified by:

clone in interface Style

Overrides:

clone in class java.lang.Object