|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.worldwind.render.AnnotationAttributes
public class AnnotationAttributes
Annotation
attributes set. All AbstractAnnotation
objects start life
referencing a new instance of this object.
This class also defines a static default attributes bundle containing default values for all attributes.
New AnnotationAttributes
refer this static bundle as their default values source when an
attribute has not been set.
New AnnotationAttributes
set have all their attributes pointing to the default values until
they are set by the application. Most attributes refer to the default value by using minus one (-1
)
for munerics and null
for objects.
The default attributes set can be changed for a non static one under the application control. The process can be extended or cascaded to handle multiple levels of inheritance for default attributes.
AbstractAnnotation
,
FrameFactory
,
MultiLineTextRenderer
Constructor Summary | |
---|---|
AnnotationAttributes()
|
Method Summary | |
---|---|
String |
getAdjustWidthToText()
Get whether the callout width should adjust to follow the wrapped text bounding rectangle width, which may be smaller or larger then the preferred size depending on the text. |
int |
getAntiAliasHint()
Get the GL antialias hint used for rendering the callout border line. |
Color |
getBackgroundColor()
Get the callout background Color . |
Color |
getBorderColor()
Get the callout border Color . |
int |
getBorderStippleFactor()
Get the stipple factor used for the callout border line. |
short |
getBorderStipplePattern()
Get the stipple pattern used for the callout border line. |
double |
getBorderWidth()
Get the callout border line width. |
int |
getCornerRadius()
Get the callout shape rounded corners radius in pixels. |
double |
getDistanceMaxScale()
Get the maximum scale that can be applied to an annotation when it gets closer to the eye than the view lookat point. |
double |
getDistanceMinOpacity()
Get the minimum opacity an annotation can have when fading away from the eye (0 to 1). |
double |
getDistanceMinScale()
Get the minimum scale that can be applied to an annotation when it gets farther away from the eye than the view lookat point. |
Point |
getDrawOffset()
Get the callout displacement offset in pixels from the globe Position or screen point at which it is associated. |
String |
getEffect()
Get the effect used to decorate the text. |
Font |
getFont()
Get the Font used for text rendering. |
String |
getFrameShape()
Get the callout frame shape. |
double |
getHighlightScale()
Get the scaling factor applied to highlighted Annotations . |
Point |
getImageOffset()
Get the background image offset in pixels (before background scaling). |
double |
getImageOpacity()
Get the opacity of the background image (0 to 1). |
String |
getImageRepeat()
Get the repeat behavior or the background image. |
double |
getImageScale()
Get the background image scaling factor. |
Object |
getImageSource()
Get the background image source. |
Insets |
getInsets()
Get the callout Insets dimensions in pixels. |
String |
getLeader()
Get the callout shape leader type. |
double |
getOpacity()
Get the opacity factor applied to the annotation. |
String |
getPath()
Get the path to the image used for background image. |
String |
getRestorableState()
Returns an XML state document String describing attributes that have been set by the application (attributes not pointing to their default value). |
double |
getScale()
Get the scaling factor applied to the annotation. |
Dimension |
getSize()
Get the annotation callout preferred total dimension in pixels. |
int |
getTextAlign()
Get the text alignement. |
Color |
getTextColor()
Get the text Color . |
boolean |
isHighlighted()
Get whether the Annotation is highlighted and should be drawn bigger - see setHighlightScale(). |
boolean |
isVisible()
Get whether the annotation is visible and should be rendered. |
void |
restoreState(String stateInXml)
Restores attribute values found in the specified XML state document String. |
void |
setAdjustWidthToText(String state)
Set whether the callout width should adjust to follow the wrapped text bounding rectangle width which may be smaller or larger then the preferred size depending on the text. |
void |
setAntiAliasHint(int hint)
Set the GL antialias hint used for rendering the callout border line. |
void |
setBackgroundColor(Color color)
Set the callout background Color . |
void |
setBorderColor(Color color)
Set the callout border Color . |
void |
setBorderStippleFactor(int factor)
Set the stipple factor used for the callout border line. |
void |
setBorderStipplePattern(short pattern)
Set the stipple pattern used for the callout border line. |
void |
setBorderWidth(double width)
Set the callout border line width. |
void |
setCornerRadius(int radius)
Set the callout shape rounded corners radius in pixels. |
void |
setDefaults(AnnotationAttributes attr)
Set the fallback default attributes set. |
void |
setDistanceMaxScale(double scale)
Set the maximum scale that can be applied to an annotation when it gets closer to the eye than the view lookat point. |
void |
setDistanceMinOpacity(double opacity)
Set the minimum opacity an annotation can have when fading away from the eye (0 to 1). |
void |
setDistanceMinScale(double scale)
Set the minimum scale that can be applied to an annotation when it gets farther away from the eye than the view lookat point. |
void |
setDrawOffset(Point offset)
Set the callout displacement offset in pixels from the globe Position or screen point at which it is associated. |
void |
setEffect(String effect)
Set the effect used to decorate the text. |
void |
setFont(Font font)
Set the Font used for text rendering. |
void |
setFrameShape(String shape)
Set the callout frame shape. |
void |
setHighlighted(boolean highlighted)
Set whether the Annotation is highlighted and should be drawn bigger - see setHighlightScale(). |
void |
setHighlightScale(double highlightScale)
Set the scaling factor applied to highlighted Annotations . |
void |
setImageOffset(Point offset)
Set the background image offset in pixels (before background scaling). |
void |
setImageOpacity(double opacity)
Set the opacity of the background image (0 to 1). |
void |
setImageRepeat(String repeat)
Set the repeat behavior or the background image. |
void |
setImageScale(double scale)
Set the background image scaling factor. |
void |
setImageSource(Object imageSource)
Set the background image source. |
void |
setInsets(Insets insets)
Set the callout Insets dimensions in pixels. |
void |
setLeader(String leader)
Set the callout shape leader type. |
void |
setOpacity(double opacity)
Set the opacity factor to apply to the annotation. |
void |
setScale(double scale)
Set the scaling factor to apply to the annotation. |
void |
setSize(Dimension size)
Set the annotation callout preferred total dimension in pixels. |
void |
setTextAlign(int align)
Set the text alignement. |
void |
setTextColor(Color color)
Set the text Color . |
void |
setVisible(boolean visible)
Set whether the annotation is visible and should be rendered. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AnnotationAttributes()
Method Detail |
---|
public String getAdjustWidthToText()
Annotation
.SIZE_FIXED or SIZE_FIT_TEXT.
public int getAntiAliasHint()
GL
antialias hint used for rendering the callout border line. Can be one of
Annotation
.ANTIALIAS_DONT_CARE, ANTIALIAS_FASTEST (default) or ANTIALIAS_NICEST.
GL
antialias hint used for rendering the callout border line.public Color getBackgroundColor()
Color
.
Color
.public Color getBorderColor()
Color
.
Color
.public int getBorderStippleFactor()
zero
(default) means no pattern
is applied.
public short getBorderStipplePattern()
public double getBorderWidth()
zero
means no border is being drawn.
public int getCornerRadius()
zero
means no rounded corners.
public double getDistanceMaxScale()
public double getDistanceMinOpacity()
public double getDistanceMinScale()
public Point getDrawOffset()
public String getEffect()
MultiLineTextRenderer
.EFFECT_SHADOW,
EFFECT_OUTLINE or EFFECT_NONE (default).
public Font getFont()
Font
used for text rendering.
Font
used for text rendering.public String getFrameShape()
FrameFactory
.SHAPE_RECTANGLE (default), SHAPE_ELLIPSE
or SHAPE_NONE.
public double getHighlightScale()
Annotations
.
Annotations
.public Point getImageOffset()
public double getImageOpacity()
public String getImageRepeat()
Annotation
.IMAGE_REPEAT_X,
IMAGE_REPEAT_Y, IMAGE_REPEAT_XY (default) or IMAGE_REPEAT_NONE.
public double getImageScale()
public Object getImageSource()
String
providing the path to a local image,
a BufferedImage
or null
.
public Insets getInsets()
Insets
dimensions in pixels. The text is drawn inside the callout frame
while keeping a distance from the callout border defined in the Insets.
Insets
dimensions in pixels.public String getLeader()
FrameFactory
.LEADER_TRIANGLE (default) or LEADER_NONE.
public double getOpacity()
public String getPath()
null
if the image source is null
or a memory BufferedImage.
public String getRestorableState()
getRestorableState
in interface Restorable
public double getScale()
public Dimension getSize()
public int getTextAlign()
MultiLineTextRenderer
.ALIGN_LEFT (default), ALIGN_CENTER
or ALIGN_RIGHT.
public Color getTextColor()
Color
.
Color
.public boolean isHighlighted()
Annotation
is highlighted and should be drawn bigger - see setHighlightScale().
public boolean isVisible()
public void restoreState(String stateInXml)
stateInXml
must be a well formed XML document String, or this will throw an
IllegalArgumentException. Unknown structures in stateInXml
are benign, because they will
simply be ignored.
restoreState
in interface Restorable
stateInXml
- an XML document String describing an AnnotationAttributes.
IllegalArgumentException
- If stateInXml
is null, or if stateInXml
is not
a well formed XML document String.public void setAdjustWidthToText(String state)
Annotation
.SIZE_FIXED (default) or SIZE_FIT_TEXT.
Setting this attribute to SIZE_FIT_TEXT
would have the callout drawn at its exact width (see setSize()).
state
- whether the callout width should adjust to follow the text bounding rectangle width.public void setAntiAliasHint(int hint)
GL
antialias hint used for rendering the callout border line. Can be one of
Annotation
.ANTIALIAS_DONT_CARE, ANTIALIAS_FASTEST (default) or ANTIALIAS_NICEST.
Set to minus one (-1
) to use the default value.
hint
- the GL
antialias hint used for rendering the callout border line.public void setBackgroundColor(Color color)
Color
. Set to null
to use the default value.
color
- the callout background Color
.public void setBorderColor(Color color)
Color
. Set to null
to use the default value.
color
- the callout border Color
.public void setBorderStippleFactor(int factor)
zero
(default) means no pattern
will be applied. Set to minus one (-1
) to use the default value.
factor
- the stipple factor used for the callout border line.public void setBorderStipplePattern(short pattern)
0x0000
to use the default value.
pattern
- the stipple pattern used for the callout border line.public void setBorderWidth(double width)
zero
means no border
will is drawn. Set to minus one (-1
) to use the default value.
width
- the callout border line width.public void setCornerRadius(int radius)
zero
means no rounded corners.
Set this attribute to minus one (-1
) to use the default value.
radius
- the callout shape rounded corners radius in pixels.public void setDefaults(AnnotationAttributes attr)
attr
- the default attributes set.public void setDistanceMaxScale(double scale)
-1
) to use the default value.
scale
- the maximum scale that can be applied to an annotation when it gets closer to the eyepublic void setDistanceMinOpacity(double opacity)
-1
) to use the default value.
opacity
- the minimum opacity an annotation can have when fading away from the eye.public void setDistanceMinScale(double scale)
-1
) to use the default value.
scale
- the minimum scale that can be applied to an annotation when it gets away from the eyepublic void setDrawOffset(Point offset)
null
to use the default offset.
offset
- the callout displacement offset in pixelspublic void setEffect(String effect)
MultiLineTextRenderer
.EFFECT_SHADOW,
EFFECT_OUTLINE or EFFECT_NONE (default). Set to null
to use the default value.
effect
- the effect to use for text renderingpublic void setFont(Font font)
Font
used for text rendering. Set to null
to use the default value.
font
- the Font
used for text rendering.public void setFrameShape(String shape)
FrameFactory
.SHAPE_RECTANGLE (default), SHAPE_ELLIPSE
or SHAPE_NONE. Set to null
to use the default shape.
Note that SHAPE_ELLIPSE draws an ellipse inside the callout bounding rectangle set by its size (see setSize()) or its text bounding rectangle (see setAdjustWidthToText() and setSize() with height set to zero). It is often necessary to have larger Insets dimensions (see setInsets()) to avoid having the text drawn outside the shape border.
shape
- the callout frame shape.public void setHighlighted(boolean highlighted)
Annotation
is highlighted and should be drawn bigger - see setHighlightScale().
highlighted
- true if highlighted.public void setHighlightScale(double highlightScale)
Annotations
. Set to minus one (-1
)
to use the default value.
highlightScale
- the scaling factor applied to highlighted Annotations
.public void setImageOffset(Point offset)
null
to use the
default value.
offset
- the background image offset in pixelspublic void setImageOpacity(double opacity)
-1
) to use the default value.
opacity
- the opacity of the background image (0 to 1).public void setImageRepeat(String repeat)
Annotation
.IMAGE_REPEAT_X,
IMAGE_REPEAT_Y, IMAGE_REPEAT_XY (default) or IMAGE_REPEAT_NONE. Set to null
to use
the default value.
repeat
- the repeat behavior or the background image.public void setImageScale(double scale)
-1
) to use the default value.
scale
- the background image scaling factor.public void setImageSource(Object imageSource)
String
providing the path to a local image
or a BufferedImage
. Set to null for no background image rendering.
imageSource
- the background image source.public void setInsets(Insets insets)
Insets
dimensions in pixels. The text will be drawn inside the callout frame
while keeping a distance from the callout border defined in the Insets. Set to null
to use the
default Insets.
insets
- the callout Insets
dimensions in pixels.public void setLeader(String leader)
FrameFactory
.LEADER_TRIANGLE (default) or LEADER_NONE.
leader
- the callout shape leader type.public void setOpacity(double opacity)
-1
) to use the default value.
opacity
- the opacity factor to apply to the annotationpublic void setScale(double scale)
-1
) to use the default value.
scale
- the scaling factor to apply to the annotationpublic void setSize(Dimension size)
If necessary, the text will be wraped into several lines so as not to exceed the callout preferred
width
(minus the Insets
left
and right
dimensions
- see setInsets()).
However, if setAdjustWidthToText() is set to true, the final callout width will follow that of the final
text bounding rectangle.
If necessary, the text will also be truncated so as not to exceed the given height
.
A zero
value (default) will have the callout follow the final text bounding rectangle height
(including the Insets
top
and bottom
).
null
to use the default size.
size
- the callout preferred total dimension in pixels.public void setTextAlign(int align)
MultiLineTextRenderer
.ALIGN_LEFT (default), ALIGN_CENTER
or ALIGN_RIGHT. Set to null
to use the default value.
align
- the text alignement.public void setTextColor(Color color)
Color
. Set to null
to use the default value.
color
- the text Color
.public void setVisible(boolean visible)
visible
- true if the annotation is visible and should be rendered.
|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |