| java.lang.Object
 org.geotools.event.AbstractGTComponent
org.geotools.styling.StrokeImpl
| StrokeImpl | | public class StrokeImpl extends AbstractGTComponent implements Stroke,Cloneable(Code) | | Provides a Java representation of the Stroke object in an SLD document. A
stroke defines how a line is rendered.
author:
James Macgill, CCG
version:
$Id: StrokeImpl.java 25459 2007-05-08 05:19:25Z jgarnett $ |
| Method Summary | |
| public void | accept(StyleVisitor visitor)
| | public Object | clone()
Clone the StrokeImpl object. | | public boolean | equals(Object oth)
Compares this stroke with another stroke for equality. | | public Expression | getColor()
This parameter gives the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. | | public java.awt.Color | getColor(org.geotools.feature.Feature feature)
| | public float[] | getDashArray()
This parameter encodes the dash pattern as a series of floats.
The first number gives the length in pixels of the dash to draw, the
second gives the amount of space to leave, and this pattern repeats.
If an odd number of values is given, then the pattern is expanded by
repeating it twice to give an even number of values. | | public Expression | getDashOffset()
This param determines where the dash pattern should start from. | | public Graphic | getGraphicFill()
This parameter indicates that a stipple-fill repeated graphic will be
used and specifies the fill graphic to use.
The graphic to use as a stipple fill. | | public Graphic | getGraphicStroke()
This parameter indicates that a repeated-linear-graphic graphic stroke
type will be used and specifies the graphic to use. | | public Expression | getLineCap()
This parameter controls how line strings should be capped.
The cap style. | | public Expression | getLineJoin()
This parameter controls how line strings should be joined together.
The join style. | | public Expression | getOpacity()
This specifies the level of translucency to use when rendering the stroke.
The value is encoded as a floating-point value between 0.0 and 1.0 with
0.0 representing totally transparent and 1.0 representing totally
opaque. | | public Expression | getWidth()
This parameter gives the absolute width (thickness) of a stroke in
pixels encoded as a float. | | public int | hashCode()
| | public void | setColor(Expression color)
This parameter sets the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. | | public void | setColor(String color)
This parameter sets the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. | | public void | setDashArray(float[] dashPattern)
This parameter encodes the dash pattern as a series of floats.
The first number gives the length in pixels of the dash to draw, the
second gives the amount of space to leave, and this pattern repeats.
If an odd number of values is given, then the pattern is expanded by
repeating it twice to give an even number of values. | | public void | setDashOffset(Expression dashOffset)
This param determines where the dash pattern should start from. | | public void | setFilterFactory(FilterFactory factory)
| | public void | setGraphicFill(Graphic fillGraphic)
This parameter indicates that a stipple-fill repeated graphic will be
used and specifies the fill graphic to use.
Parameters:
fillGraphic - The graphic to use as a stipple fill. | | public void | setGraphicStroke(Graphic strokeGraphic)
This parameter indicates that a repeated-linear-graphic graphic stroke
type will be used and specifies the graphic to use. | | public void | setLineCap(Expression lineCap)
This parameter controls how line strings should be capped.
Parameters:
lineCap - The cap style. | | public void | setLineJoin(Expression lineJoin)
This parameter controls how line strings should be joined together.
Parameters:
lineJoin - The join style. | | public void | setOpacity(Expression opacity)
This specifies the level of translucency to use when rendering the stroke.
The value is encoded as a floating-point value between 0.0 and 1.0 with
0.0 representing totally transparent and 1.0 representing totally
opaque. | | public void | setWidth(Expression width)
This parameter sets the absolute width (thickness) of a stroke in pixels
encoded as a float. | | public String | toString()
|
| StrokeImpl | | protected StrokeImpl()(Code) | | Creates a new instance of Stroke
|
| StrokeImpl | | protected StrokeImpl(FilterFactory factory)(Code) | | |
| equals | | public boolean equals(Object oth)(Code) | | Compares this stroke with another stroke for equality.
Parameters:
oth - The other StrokeImpl to compare True if this and oth are equal. |
| getColor | | public Expression getColor()(Code) | | This parameter gives the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. The hexidecimal digits between A and F may be in
either upper or lower case. For example, full red is encoded as
"#ff0000" (with no quotation marks). The default color is defined to
be black ("#000000"). Note: in CSS this parameter is just called Stroke
and not Color.
The color of the stroke encoded as a hexidecimal RGB value. |
| getDashArray | | public float[] getDashArray()(Code) | | This parameter encodes the dash pattern as a series of floats.
The first number gives the length in pixels of the dash to draw, the
second gives the amount of space to leave, and this pattern repeats.
If an odd number of values is given, then the pattern is expanded by
repeating it twice to give an even number of values. The default is to
draw an unbroken line.
For example, "2 1 3 2" would produce:
-- --- -- --- --
--- -- --- -- --- --
The dash pattern as an array of float values in the form"dashlength gaplength ..." |
| getDashOffset | | public Expression getDashOffset()(Code) | | This param determines where the dash pattern should start from.
where the dash should start from. |
| getGraphicFill | | public Graphic getGraphicFill()(Code) | | This parameter indicates that a stipple-fill repeated graphic will be
used and specifies the fill graphic to use.
The graphic to use as a stipple fill. If null, then no Stipplefill should be used. |
| getGraphicStroke | | public Graphic getGraphicStroke()(Code) | | This parameter indicates that a repeated-linear-graphic graphic stroke
type will be used and specifies the graphic to use. Proper stroking
with a linear graphic requires two "hot-spot" points within the space
of the graphic to indicate where the rendering line starts and stops.
In the case of raster images with no special mark-up, this line will be
assumed to be the middle pixel row of the image, starting from the
first pixel column and ending at the last pixel column.
The graphic to use as a linear graphic. If null, then no graphicstroke should be used. |
| getLineCap | | public Expression getLineCap()(Code) | | This parameter controls how line strings should be capped.
The cap style. This will be one of "butt", "round" and "square"There is no defined default. |
| getLineJoin | | public Expression getLineJoin()(Code) | | This parameter controls how line strings should be joined together.
The join style. This will be one of "mitre", "round" and"bevel". There is no defined default. |
| getOpacity | | public Expression getOpacity()(Code) | | This specifies the level of translucency to use when rendering the stroke.
The value is encoded as a floating-point value between 0.0 and 1.0 with
0.0 representing totally transparent and 1.0 representing totally
opaque. A linear scale of translucency is used for intermediate values.
For example, "0.65" would represent 65% opacity. The default value is
1.0 (opaque).
The opacity of the stroke, where 0.0 is completely transparentand 1.0 is completely opaque. |
| getWidth | | public Expression getWidth()(Code) | | This parameter gives the absolute width (thickness) of a stroke in
pixels encoded as a float. The default is 1.0. Fractional numbers are
allowed but negative numbers are not.
The width of the stroke in pixels. This may be fractional butnot negative. |
| hashCode | | public int hashCode()(Code) | | |
| setColor | | public void setColor(Expression color)(Code) | | This parameter sets the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. The hexidecimal digits between A and F may be in
either upper or lower case. For example, full red is encoded as
"#ff0000" (with no quotation marks). The default color is defined to
be black ("#000000"). Note: in CSS this parameter is just called Stroke
and not Color.
Parameters:
color - The color of the stroke encoded as a hexidecimal RGB value.This must not be null.
throws:
IllegalArgumentException - DOCUMENT ME! |
| setColor | | public void setColor(String color)(Code) | | This parameter sets the solid color that will be used for a stroke.
The color value is RGB-encoded using two hexidecimal digits per
primary-color component in the order Red, Green, Blue, prefixed with
the hash (#) sign. The hexidecimal digits between A and F may be in
either upper or lower case. For example, full red is encoded as
"#ff0000" (with no quotation marks). The default color is defined to
be black ("#000000"). Note: in CSS this parameter is just called Stroke
and not Color.
Parameters:
color - The color of the stroke encoded as a hexidecimal RGB value. |
| setDashArray | | public void setDashArray(float[] dashPattern)(Code) | | This parameter encodes the dash pattern as a series of floats.
The first number gives the length in pixels of the dash to draw, the
second gives the amount of space to leave, and this pattern repeats.
If an odd number of values is given, then the pattern is expanded by
repeating it twice to give an even number of values. The default is to
draw an unbroken line.
For example, "2 1 3 2" would produce:
-- --- -- ---
-- --- -- --- --
--- --
Parameters:
dashPattern - The dash pattern as an array of float values in theform "dashlength gaplength ..." |
| setDashOffset | | public void setDashOffset(Expression dashOffset)(Code) | | This param determines where the dash pattern should start from.
Parameters:
dashOffset - The distance into the dash pattern that should act asthe start. |
| setFilterFactory | | public void setFilterFactory(FilterFactory factory)(Code) | | |
| setGraphicFill | | public void setGraphicFill(Graphic fillGraphic)(Code) | | This parameter indicates that a stipple-fill repeated graphic will be
used and specifies the fill graphic to use.
Parameters:
fillGraphic - The graphic to use as a stipple fill. If null, thenno Stipple fill should be used. |
| setGraphicStroke | | public void setGraphicStroke(Graphic strokeGraphic)(Code) | | This parameter indicates that a repeated-linear-graphic graphic stroke
type will be used and specifies the graphic to use. Proper stroking
with a linear graphic requires two "hot-spot" points within the space
of the graphic to indicate where the rendering line starts and stops.
In the case of raster images with no special mark-up, this line will be
assumed to be the middle pixel row of the image, starting from the
first pixel column and ending at the last pixel column.
Parameters:
strokeGraphic - The graphic to use as a linear graphic. If null,then no graphic stroke should be used. |
| setLineCap | | public void setLineCap(Expression lineCap)(Code) | | This parameter controls how line strings should be capped.
Parameters:
lineCap - The cap style. This can be one of "butt", "round" and"square" There is no defined default. |
| setLineJoin | | public void setLineJoin(Expression lineJoin)(Code) | | This parameter controls how line strings should be joined together.
Parameters:
lineJoin - The join style. This will be one of "mitre", "round"and "bevel". There is no defined default. |
| setOpacity | | public void setOpacity(Expression opacity)(Code) | | This specifies the level of translucency to use when rendering the stroke.
The value is encoded as a floating-point value between 0.0 and 1.0 with
0.0 representing totally transparent and 1.0 representing totally
opaque. A linear scale of translucency is used for intermediate values.
For example, "0.65" would represent 65% opacity. The default value is
1.0 (opaque).
Parameters:
opacity - The opacity of the stroke, where 0.0 is completelytransparent and 1.0 is completely opaque. |
| setWidth | | public void setWidth(Expression width)(Code) | | This parameter sets the absolute width (thickness) of a stroke in pixels
encoded as a float. The default is 1.0. Fractional numbers are allowed
but negative numbers are not.
Parameters:
width - The width of the stroke in pixels. This may be fractionalbut not negative. |
|
|