gov.nasa.worldwind.util.tree
Interface FrameAttributes

All Known Implementing Classes:

BasicFrameAttributes

public interface FrameAttributes

Attributes to control how a ScrollFrame is rendered.

See Also:

ScrollFrame

Method Summary

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.
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.
Font	getFont() Get the font used to render text.
Color	getForegroundColor() Get the color of the text in the frame.
double	getForegroundOpacity() Get the opacity of the text and images in the frame.
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.
Color	getMinimizeButtonColor() Get the color of the minimize button drawn in the upper right corner of the frame.
Color[]	getScrollBarColor() Get the colors used to draw the frame's scroll bars.
Color	getTextColor() Get the color of the text in the frame title bar.
Color[]	getTitleBarColor() Get the colors that make up the frame's title bar gradient.
void	setBackgroundColor(Color frameColor1, 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(Font font) Set the font used to render text.
void	setForegroundColor(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(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(Color color) Set the color of the minimize button drawn in the upper right corner of the frame.
void	setScrollBarColor(Color color1, Color color2) Set the colors in the scroll bar gradient.
void	setTextColor(Color color) Set the color of the text in the frame title bar.
void	setTitleBarColor(Color color1, 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.

getBackgroundColor

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)

getBackgroundOpacity

double getBackgroundOpacity()

Get the opacity of the frame.

Returns:

Frame opacity.

See Also:

setBackgroundOpacity(double)

getCornerRadius

int getCornerRadius()

Get the radius of the frame corners. A value of zero means square corners.

Returns:

The radius of the frame corners, in pixels.

getFont

Font getFont()

Get the font used to render text.

Returns:

frame font.

See Also:

setFont(java.awt.Font)

getForegroundColor

Color getForegroundColor()

Get the color of the text in the frame.

Returns:

The foreground color.

See Also:

setForegroundColor(java.awt.Color)

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()

getIconSize

Dimension getIconSize()

Get the size of the icon in the frame title bar.

Returns:

Icon size.

See Also:

setIconSize(java.awt.Dimension)

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)

getMinimizeButtonColor

Color getMinimizeButtonColor()

Get the color of the minimize button drawn in the upper right corner of the frame.

Returns:

Color of the minimize button.

getScrollBarColor

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)

getTextColor

Color getTextColor()

Get the color of the text in the frame title bar.

Returns:

The color of text in the tree frame.

getTitleBarColor

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)

setBackgroundColor

void setBackgroundColor(Color frameColor1,
                        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()

setBackgroundOpacity

void setBackgroundOpacity(double frameOpacity)

Set the opacity of the frame.

Parameters:

frameOpacity - New frame opacity.

See Also:

getBackgroundOpacity()

setCornerRadius

void setCornerRadius(int cornerRadius)

Set the radius of the frame corners.

Parameters:

cornerRadius - New radius, in pixels. A value of zero means square corners.

setFont

void setFont(Font font)

Set the font used to render text.

Parameters:

font - New frame font.

See Also:

getFont()

setForegroundColor

void setForegroundColor(Color color)

Set the color of the text in the frame.

Parameters:

color - New foreground color.

See Also:

getForegroundColor()

setForegroundOpacity

void setForegroundOpacity(double textOpacity)

Set the opacity of the frame text and images.

Parameters:

textOpacity - New opacity.

See Also:

getForegroundOpacity(), setBackgroundOpacity(double)

setIconSize

void setIconSize(Dimension size)

Set the size of each icon in the frame title bar.

Parameters:

size - New size.

See Also:

getIconSize()

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()

setMinimizeButtonColor

void setMinimizeButtonColor(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.

setScrollBarColor

void setScrollBarColor(Color color1,
                       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()

setTextColor

void setTextColor(Color color)

Set the color of the text in the frame title bar.

Parameters:

color - The new color of text in the tree frame.

setTitleBarColor

void setTitleBarColor(Color color1,
                      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()