Package gov.nasa.worldwind.util.tree
Interface FrameAttributes
-
- All Known Implementing Classes:
BasicFrameAttributes
public interface FrameAttributes
Attributes to control how aScrollFrame
is rendered.- See Also:
ScrollFrame
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FrameAttributes
copy()
Returns a new FrameAttributes instance of the same type as this FrameAttributes, who's properties are configured exactly as this FrameAttributes.void
copy(FrameAttributes attributes)
Copies the specified FrameAttributes' properties into this object's properties.java.awt.Color[]
getBackgroundColor()
Get the colors that make up the frame's background gradient.double
getBackgroundOpacity()
Get the opacity of the frame.int
getCornerRadius()
Get the radius of the frame corners.java.awt.Font
getFont()
Get the font used to render text.java.awt.Color
getForegroundColor()
Get the color of the text in the frame.double
getForegroundOpacity()
Get the opacity of the text and images in the frame.java.awt.Dimension
getIconSize()
Get the size of the icon in the frame title bar.int
getIconSpace()
Get the amount of space, in pixels, to leave between an icon in the frame and surrounding text and shapes.java.awt.Color
getMinimizeButtonColor()
Get the color of the minimize button drawn in the upper right corner of the frame.java.awt.Color[]
getScrollBarColor()
Get the colors used to draw the frame's scroll bars.java.awt.Color
getTextColor()
Get the color of the text in the frame title bar.java.awt.Color[]
getTitleBarColor()
Get the colors that make up the frame's title bar gradient.void
setBackgroundColor(java.awt.Color frameColor1, java.awt.Color frameColor2)
Set the colors in the background gradient of the frame.void
setBackgroundOpacity(double frameOpacity)
Set the opacity of the frame.void
setCornerRadius(int cornerRadius)
Set the radius of the frame corners.void
setFont(java.awt.Font font)
Set the font used to render text.void
setForegroundColor(java.awt.Color color)
Set the color of the text in the frame.void
setForegroundOpacity(double textOpacity)
Set the opacity of the frame text and images.void
setIconSize(java.awt.Dimension size)
Set the size of each icon in the frame title bar.void
setIconSpace(int iconSpace)
Set the amount of space, in pixels, to leave between an icon in the frame and surrounding text and shapes.void
setMinimizeButtonColor(java.awt.Color color)
Set the color of the minimize button drawn in the upper right corner of the frame.void
setScrollBarColor(java.awt.Color color1, java.awt.Color color2)
Set the colors in the scroll bar gradient.void
setTextColor(java.awt.Color color)
Set the color of the text in the frame title bar.void
setTitleBarColor(java.awt.Color color1, java.awt.Color color2)
Set the colors in the title bar gradient.
-
-
-
Method Detail
-
copy
FrameAttributes copy()
Returns a new FrameAttributes instance of the same type as this FrameAttributes, who's properties are configured exactly as this FrameAttributes.- Returns:
- a copy of this FrameAttributes.
-
copy
void copy(FrameAttributes attributes)
Copies the specified FrameAttributes' properties into this object's properties. This does nothing if the specified attributes is null.- Parameters:
attributes
- the attributes to copy.
-
getForegroundColor
java.awt.Color getForegroundColor()
Get the color of the text in the frame.- Returns:
- The foreground color.
- See Also:
setForegroundColor(java.awt.Color)
-
setForegroundColor
void setForegroundColor(java.awt.Color color)
Set the color of the text in the frame.- Parameters:
color
- New foreground color.- See Also:
getForegroundColor()
-
getFont
java.awt.Font getFont()
Get the font used to render text.- Returns:
- frame font.
- See Also:
setFont(java.awt.Font)
-
setFont
void setFont(java.awt.Font font)
Set the font used to render text.- Parameters:
font
- New frame font.- See Also:
getFont()
-
getTextColor
java.awt.Color getTextColor()
Get the color of the text in the frame title bar.- Returns:
- The color of text in the tree frame.
-
setTextColor
void setTextColor(java.awt.Color color)
Set the color of the text in the frame title bar.- Parameters:
color
- The new color of text in the tree frame.
-
getIconSize
java.awt.Dimension getIconSize()
Get the size of the icon in the frame title bar.- Returns:
- Icon size.
- See Also:
setIconSize(java.awt.Dimension)
-
setIconSize
void setIconSize(java.awt.Dimension size)
Set the size of each icon in the frame title bar.- Parameters:
size
- New size.- See Also:
getIconSize()
-
getIconSpace
int getIconSpace()
Get the amount of space, in pixels, to leave between an icon in the frame and surrounding text and shapes.- Returns:
- Icon space in pixels.
- See Also:
setIconSpace(int)
-
setIconSpace
void setIconSpace(int iconSpace)
Set the amount of space, in pixels, to leave between an icon in the frame and surrounding text and shapes.- Parameters:
iconSpace
- Icon space in pixels.- See Also:
getIconSpace()
-
getForegroundOpacity
double getForegroundOpacity()
Get the opacity of the text and images in the frame.- Returns:
- Opacity of text and images.
- See Also:
setForegroundOpacity(double)
,getBackgroundOpacity()
-
setForegroundOpacity
void setForegroundOpacity(double textOpacity)
Set the opacity of the frame text and images.- Parameters:
textOpacity
- New opacity.- See Also:
getForegroundOpacity()
,setBackgroundOpacity(double)
-
getBackgroundOpacity
double getBackgroundOpacity()
Get the opacity of the frame.- Returns:
- Frame opacity.
- See Also:
setBackgroundOpacity(double)
-
setBackgroundOpacity
void setBackgroundOpacity(double frameOpacity)
Set the opacity of the frame.- Parameters:
frameOpacity
- New frame opacity.- See Also:
getBackgroundOpacity()
-
getBackgroundColor
java.awt.Color[] getBackgroundColor()
Get the colors that make up the frame's background gradient.- Returns:
- Two element array containing the colors in the background gradient.
- See Also:
setBackgroundColor(java.awt.Color, java.awt.Color)
-
setBackgroundColor
void setBackgroundColor(java.awt.Color frameColor1, java.awt.Color frameColor2)
Set the colors in the background gradient of the frame.- Parameters:
frameColor1
- First color in frame gradient.frameColor2
- Second color in frame gradient.- See Also:
getBackgroundColor()
-
getTitleBarColor
java.awt.Color[] getTitleBarColor()
Get the colors that make up the frame's title bar gradient.- Returns:
- Two element array containing the colors in the title bar gradient.
- See Also:
setTitleBarColor(java.awt.Color, java.awt.Color)
-
setTitleBarColor
void setTitleBarColor(java.awt.Color color1, java.awt.Color color2)
Set the colors in the title bar gradient.- Parameters:
color1
- First color in the title bar gradient.color2
- Second color in the title bar gradient.- See Also:
getTitleBarColor()
-
getScrollBarColor
java.awt.Color[] getScrollBarColor()
Get the colors used to draw the frame's scroll bars.- Returns:
- Two element array containing the colors in the scroll bar gradient.
- See Also:
setScrollBarColor(java.awt.Color, java.awt.Color)
-
setScrollBarColor
void setScrollBarColor(java.awt.Color color1, java.awt.Color color2)
Set the colors in the scroll bar gradient.- Parameters:
color1
- First color in the scroll bar gradient.color2
- Second color in the scroll bar gradient.- See Also:
getScrollBarColor()
-
getMinimizeButtonColor
java.awt.Color getMinimizeButtonColor()
Get the color of the minimize button drawn in the upper right corner of the frame.- Returns:
- Color of the minimize button.
-
setMinimizeButtonColor
void setMinimizeButtonColor(java.awt.Color color)
Set the color of the minimize button drawn in the upper right corner of the frame.- Parameters:
color
- Color of the minimize button.
-
getCornerRadius
int getCornerRadius()
Get the radius of the frame corners. A value ofzero
means square corners.- Returns:
- The radius of the frame corners, in pixels.
-
setCornerRadius
void setCornerRadius(int cornerRadius)
Set the radius of the frame corners.- Parameters:
cornerRadius
- New radius, in pixels. A value ofzero
means square corners.
-
-