|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TextSymbolizer
Encapsulates the style data applicable to
Graphic
s
that are of type Text in the sense of SLD (OGC 02-070).
Note that the "fill color" of a TextSymbolizer
could also be
called the "text color" as it is the primary color used to draw the text.
Field Summary | |
---|---|
static Color |
DEFAULT_FILL_BACKGROUND_COLOR
Default fill background color value. |
static Color |
DEFAULT_FILL_COLOR
Default fill color value. |
static float |
DEFAULT_FILL_OPACITY
Default fill opacity value. |
static FillPattern |
DEFAULT_FILL_PATTERN
Default fill pattern value. |
static FillStyle |
DEFAULT_FILL_STYLE
Default fill style value. |
static Font |
DEFAULT_FONT
|
static float |
DEFAULT_HALO_RADIUS
Default halo radius value. |
static float |
DEFAULT_ROTATION
Default rotation. |
static XAnchor |
DEFAULT_X_ANCHOR
Default xAnchor. |
static float |
DEFAULT_X_DISPLACEMENT
Default xDisplacement. |
static YAnchor |
DEFAULT_Y_ANCHOR
Default yAnchor. |
static float |
DEFAULT_Y_DISPLACEMENT
Default yDisplacement. |
Method Summary | |
---|---|
Color |
getBackgroundColor()
Returns the color that is used to fill in a bounding box behind the text, or null if no background is to be drawn using this symbolizer. |
Color |
getFillBackgroundColor()
Returns the color that is used as the pattern background color when a stipple pattern is used for the fill color. |
Color |
getFillColor()
Returns the color used to draw the text. |
float[] |
getFillGradientPoints()
Returns the fill gradient points value, or null if there is no fill gradient. |
float |
getFillOpacity()
Returns the fill opacity value. |
FillPattern |
getFillPattern()
Returns the fill pattern value. |
FillStyle |
getFillStyle()
Returns the fill style value. |
Font |
getFont()
Returns the Font object. |
Color |
getHaloColor()
Returns the color that is used to fill in the halo, or null if no halo is to be drawn. |
float |
getHaloRadius()
Returns the halo radius value, or zero if no halo is to be drawn. |
float |
getRotation()
Returns the label rotation. |
XAnchor |
getXAnchor()
Returns the label XAnchor. |
float |
getXDisplacement()
Returns the label X displacement. |
YAnchor |
getYAnchor()
Returns the label YAnchor. |
float |
getYDisplacement()
Returns the label Y displacement. |
void |
setBackgroundColor(Color backgroundColor)
Sets the color that is used for rendering a background behind the text. |
void |
setFillBackgroundColor(Color fillBackgroundColor)
Sets the color that is used as the pattern background color when a stipple pattern is used for the fill color. |
void |
setFillColor(Color fillColor)
Sets the color used to draw the text. |
void |
setFillGradientPoints(float[] fillGradientPoints)
Sets the fill gradient points value. |
void |
setFillOpacity(float fillOpacity)
Sets the fill opacity value. |
void |
setFillPattern(FillPattern fillPattern)
Sets the fill pattern value. |
void |
setFillStyle(FillStyle fillStyle)
Sets the fill style value. |
void |
setFont(Font object)
Sets the Font object. |
void |
setHaloColor(Color haloColor)
Sets the halo color. |
void |
setHaloRadius(float haloRadius)
Sets the halo radius value. |
void |
setRotation(float labelRotation)
Sets the label rotation. |
void |
setXAnchor(XAnchor xAnchor)
Sets the label XAnchor. |
void |
setXDisplacement(float xDisplacement)
Sets the label X displacement. |
void |
setYAnchor(YAnchor yAnchor)
Sets the label YAnchor. |
void |
setYDisplacement(float yDisplacement)
Sets the label Y displacement. |
Methods inherited from interface GraphicStyle |
---|
addGraphicStyleListener, clone, getImplHint, removeGraphicStyleListener, setImplHint, setPropertiesFrom |
Field Detail |
---|
static final Color DEFAULT_FILL_COLOR
static final Color DEFAULT_FILL_BACKGROUND_COLOR
static final float DEFAULT_FILL_OPACITY
static final FillPattern DEFAULT_FILL_PATTERN
static final FillStyle DEFAULT_FILL_STYLE
static final Font DEFAULT_FONT
static final float DEFAULT_HALO_RADIUS
static final float DEFAULT_ROTATION
static final XAnchor DEFAULT_X_ANCHOR
static final float DEFAULT_X_DISPLACEMENT
static final YAnchor DEFAULT_Y_ANCHOR
static final float DEFAULT_Y_DISPLACEMENT
Method Detail |
---|
Color getFillColor()
void setFillColor(Color fillColor)
fillColor
- the text foreground color.Color getFillBackgroundColor()
void setFillBackgroundColor(Color fillBackgroundColor)
fillBackgroundColor
- the font glyph background color for
stippled text rendering.float[] getFillGradientPoints()
void setFillGradientPoints(float[] fillGradientPoints)
fillGradientPoints
- the fill gradient points value, or null to
specify no fill gradient.float getFillOpacity()
void setFillOpacity(float fillOpacity)
fillOpacity
- the fill opacity value.FillPattern getFillPattern()
void setFillPattern(FillPattern fillPattern)
fillPattern
- the fill pattern value.FillStyle getFillStyle()
void setFillStyle(FillStyle fillStyle)
fillStyle
- the fill style value.Font getFont()
void setFont(Font object)
object
- the Font object.float getHaloRadius()
void setHaloRadius(float haloRadius)
haloRadius
- the value of the halo radius.Color getHaloColor()
void setHaloColor(Color haloColor)
haloColor
- the halo color.Color getBackgroundColor()
void setBackgroundColor(Color backgroundColor)
backgroundColor
- the font glyph background color for
stippled text rendering.float getRotation()
void setRotation(float labelRotation)
labelRotation
- the label rotation.XAnchor getXAnchor()
void setXAnchor(XAnchor xAnchor)
xAnchor
- the label XAnchor.float getXDisplacement()
void setXDisplacement(float xDisplacement)
xDisplacement
- the label X displacement.YAnchor getYAnchor()
void setYAnchor(YAnchor yAnchor)
yAnchor
- the label YAnchor.float getYDisplacement()
void setYDisplacement(float yDisplacement)
yDisplacement
- the label Y displacement.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |