echopoint
Class GroupBox

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.Container
          echopoint.EchoPointComponent
              echopoint.GroupBox

All Implemented Interfaces:

LayoutManageable, Borderable, MouseCursorable, ToolTipPopUpSupport, ReflectionSetter, java.io.Serializable, Component, ToolTipSupport

public class GroupBox
extends EchoPointComponent
implements LayoutManageable, Borderable

The GroupBox class provides a Container that can contain other Components or objects with a border and a title.
A GroupBox is as wide as its container, regardless of how big its contents are.

See Also:

Serialized Form

Nested Class Summary

static class

GroupBox.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static Insets	DEFAULT_INSETS
static java.lang.String	INSETS_CHANGED_PROPERTY Property Change Names
static java.lang.String	LAYOUT_MANAGED_CHANGED_PROPERTY
static java.lang.String	RENDERING_CHANGED_PROPERTY
static java.lang.String	STYLE_INSETS A style constant for the Insets property.
static java.lang.String	STYLE_TITLE A style constant for the Title property.
static java.lang.String	STYLE_TITLE_COLOR A style constant for the TitleColor property.
static java.lang.String	TITLE_CHANGED_PROPERTY
static java.lang.String	TITLE_COLOR_CHANGED_PROPERTY

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

GroupBox()
Constructs a GroupBox with nothing in it

GroupBox(LayoutManager layoutManager)
Constructs a GroupBox with a LayoutManager

GroupBox(java.lang.String title)
Constructs a GroupBox with nothing in it and the designated title

Method Summary

void	add(Component c) Adds a Component to the GroupBox
void	add(Component c, int index) Adds a Component to the GroupBox at the specified index
void	add(Component comp, java.lang.Object constraints) Adds a Component to the GroupBox at the end of the list.
void	add(Component comp, java.lang.Object constraints, int index) Adds a Component to the GroupBox at the specified index.
protected void	addImpl(Component comp, java.lang.Object contraints, int index) The common implementation of add that notifies thge LayoutAManager if necessary
void	applyStyle(Style style) Applies the provided style to the component.
Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
Insets	getInsets()
LayoutManager	getLayoutManager() Returns the LayoutManager of the LayoutManageable container, or null if one is not present.
Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
java.lang.String	getTitle()
Color	getTitleColor()
Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
boolean	isComplexRendering()
void	remove(Component c) Removes a component from the GroupBox.
void	remove(int index) Removes a component from the GroupBox at the given index.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setBorderColor(Color newBorderColor) Sets the Color of the Borderable's border.
void	setBorderSize(int newBorderSize) Sets the size of the Borderables's border.
void	setBorderStyle(int borderStyle) Sets the border style of the Borderable.
void	setBottomBorderColor(Color borderColor) Sets the Color of the Borderable's bottom border.
void	setBottomBorderSize(int borderSize) Sets the size of the Borderables's bottom border.
void	setBottomBorderStyle(int borderStyle) Sets the border style of the Borderables's bottom border.
void	setComplexRendering(boolean newRendering) Sets whether complex rendering is used by the GroupBox.
void	setInsets(Insets newValue) Sets the Insets used by the GroupBox This methods fires a PropertyChangeEvent with a getPropertyName() value of GroupBox.INSETS_CHANGED_PROPERTY
void	setLayoutManager(LayoutManager newLayoutManager) Sets a new LayoutManager into the LayoutManageable container.
void	setLeftBorderColor(Color borderColor) Sets the Color of the Borderable's left border.
void	setLeftBorderSize(int borderSize) Sets the size of the Borderables's left border.
void	setLeftBorderStyle(int borderStyle) Sets the border style of the Borderables's left border.
void	setRightBorderColor(Color borderColor) Sets the Color of the Borderable's right border.
void	setRightBorderSize(int borderSize) Sets the size of the Borderables's right border.
void	setRightBorderStyle(int borderStyle) Sets the border style of the Borderables's right border.
void	setTitle(java.lang.String newValue) Sets the title of the GroupBox.
void	setTitleColor(Color newValue) Sets the titleColor of the GroupBox.
void	setTopBorderColor(Color borderColor) Sets the Color of the Borderable's top border.
void	setTopBorderSize(int borderSize) Sets the size of the Borderables's top border.
void	setTopBorderStyle(int borderStyle) Sets the border style of the Borderables's top border.

Methods inherited from class echopoint.EchoPointComponent

getMouseCursor, getMouseCursorURI, getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, setMouseCursor, setMouseCursorURI, setToolTipText, validate

Methods inherited from class nextapp.echo.AbstractComponent

addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STYLE_INSETS

public static final java.lang.String STYLE_INSETS

A style constant for the Insets property. Values of this key must be of type nextapp.echo.Insets.

See Also:

Constant Field Values

STYLE_TITLE

public static final java.lang.String STYLE_TITLE

A style constant for the Title property. Values of this key must be of type String

See Also:

Constant Field Values

STYLE_TITLE_COLOR

public static final java.lang.String STYLE_TITLE_COLOR

A style constant for the TitleColor property. Values of this key must be of type nextapp.echo.Color

See Also:

Constant Field Values

INSETS_CHANGED_PROPERTY

public static final java.lang.String INSETS_CHANGED_PROPERTY

Property Change Names

See Also:

Constant Field Values

RENDERING_CHANGED_PROPERTY

public static final java.lang.String RENDERING_CHANGED_PROPERTY

See Also:

Constant Field Values

TITLE_CHANGED_PROPERTY

public static final java.lang.String TITLE_CHANGED_PROPERTY

See Also:

Constant Field Values

TITLE_COLOR_CHANGED_PROPERTY

public static final java.lang.String TITLE_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

LAYOUT_MANAGED_CHANGED_PROPERTY

public static final java.lang.String LAYOUT_MANAGED_CHANGED_PROPERTY

See Also:

Constant Field Values

DEFAULT_INSETS

public static final Insets DEFAULT_INSETS

Constructor Detail

GroupBox

public GroupBox()

Constructs a GroupBox with nothing in it

GroupBox

public GroupBox(LayoutManager layoutManager)

Constructs a GroupBox with a LayoutManager

GroupBox

public GroupBox(java.lang.String title)

Constructs a GroupBox with nothing in it and the designated title

Method Detail

add

public void add(Component c)

Adds a Component to the GroupBox

Specified by:

add in interface LayoutManageable

Specified by:

add in interface Component

Overrides:

add in class AbstractComponent

Parameters:

c - The child component to add.

add

public void add(Component c,
                int index)

Adds a Component to the GroupBox at the specified index

Specified by:

add in interface LayoutManageable

Specified by:

add in interface Component

Overrides:

add in class AbstractComponent

Parameters:

c - The child component to add.

index - The index at which to add the child component, or -1 to add the component at the end.

add

public void add(Component comp,
                java.lang.Object constraints)

Adds a Component to the GroupBox at the end of the list.

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

add

public void add(Component comp,
                java.lang.Object constraints,
                int index)

Adds a Component to the GroupBox at the specified index.

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

addImpl

protected void addImpl(Component comp,
                       java.lang.Object contraints,
                       int index)

The common implementation of add that notifies thge LayoutAManager if necessary

applyStyle

public void applyStyle(Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

Specified by:

applyStyle in interface Borderable

Specified by:

applyStyle in interface MouseCursorable

Specified by:

applyStyle in interface Component

Overrides:

applyStyle in class EchoPointComponent

Parameters:

style - The style object from which to retrieve properties for this Component.

See Also:

Component.applyStyle(nextapp.echo.Style)

getInsets

public Insets getInsets()

Returns:

the Insets (margins) of the GroupBox.

getLayoutManager

public LayoutManager getLayoutManager()

Returns the LayoutManager of the LayoutManageable container, or null if one is not present.

Specified by:

getLayoutManager in interface LayoutManageable

getTitle

public java.lang.String getTitle()

Returns:

The size of the GroupBox's title.

getTitleColor

public Color getTitleColor()

Returns:

The color of the GroupBox's title.

isComplexRendering

public boolean isComplexRendering()

remove

public void remove(int index)

Removes a component from the GroupBox at the given index.

This method then informs any LayoutManager that is removed.

Specified by:

remove in interface LayoutManageable

Specified by:

remove in interface Component

Overrides:

remove in class AbstractComponent

Parameters:

index - The index of the child component to remove.

remove

public void remove(Component c)

Removes a component from the GroupBox.

This method then informs any LayoutManager that is removed.

Specified by:

remove in interface LayoutManageable

Specified by:

remove in interface Component

Overrides:

remove in class AbstractComponent

Parameters:

c - The child component to remove.

getBorderColor

public Color getBorderColor()

Specified by:

getBorderColor in interface Borderable

Returns:

The Color of the Borderable's border.

See Also:

Borderable.getBorderColor()

getBorderSize

public int getBorderSize()

Specified by:

getBorderSize in interface Borderable

Returns:

The size of the Borderables's border.

See Also:

Borderable.getBorderSize()

getBorderStyle

public int getBorderStyle()

Description copied from interface: Borderable

Returns the border style of the Borderable. This will be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

Specified by:

getBorderStyle in interface Borderable

Returns:

int the current border style

See Also:

Borderable.getBorderStyle()

setBorderColor

public void setBorderColor(Color newBorderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's border. This will also set the left, top, right and bottom border color.

Specified by:

setBorderColor in interface Borderable

See Also:

Borderable.setBorderColor(nextapp.echo.Color)

setBorderSize

public void setBorderSize(int newBorderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's border. This will also set the left, top, right and bottom border size.

Specified by:

setBorderSize in interface Borderable

See Also:

Borderable.setBorderSize(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderable. This must be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

This will also set the left, top, right and bottom border style.

Specified by:

setBorderStyle in interface Borderable

See Also:

Borderable.setBorderStyle(int)

getLeftBorderColor

public Color getLeftBorderColor()

Specified by:

getLeftBorderColor in interface Borderable

Returns:

The Color of the Borderable's left border.

See Also:

Borderable.getLeftBorderColor()

getLeftBorderSize

public int getLeftBorderSize()

Specified by:

getLeftBorderSize in interface Borderable

Returns:

The size of the Borderables's left border.

See Also:

Borderable.getLeftBorderSize()

getLeftBorderStyle

public int getLeftBorderStyle()

Specified by:

getLeftBorderStyle in interface Borderable

Returns:

The style of the Borderables's left border.

See Also:

Borderable.getLeftBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's left border.

Specified by:

setLeftBorderColor in interface Borderable

See Also:

Borderable.setLeftBorderColor(nextapp.echo.Color)

setLeftBorderSize

public void setLeftBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's left border.

Specified by:

setLeftBorderSize in interface Borderable

See Also:

Borderable.setLeftBorderSize(int)

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's left border.

Specified by:

setLeftBorderStyle in interface Borderable

See Also:

Borderable.setLeftBorderStyle(int)

getTopBorderColor

public Color getTopBorderColor()

Specified by:

getTopBorderColor in interface Borderable

Returns:

The Color of the Borderable's top border.

See Also:

Borderable.getTopBorderColor()

getTopBorderSize

public int getTopBorderSize()

Specified by:

getTopBorderSize in interface Borderable

Returns:

The size of the Borderables's top border.

See Also:

Borderable.getTopBorderSize()

getTopBorderStyle

public int getTopBorderStyle()

Specified by:

getTopBorderStyle in interface Borderable

Returns:

The style of the Borderables's top border.

See Also:

Borderable.getTopBorderStyle()

setTopBorderColor

public void setTopBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's top border.

Specified by:

setTopBorderColor in interface Borderable

See Also:

Borderable.setTopBorderColor(nextapp.echo.Color)

setTopBorderSize

public void setTopBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's top border.

Specified by:

setTopBorderSize in interface Borderable

See Also:

Borderable.setTopBorderSize(int)

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's top border.

Specified by:

setTopBorderStyle in interface Borderable

See Also:

Borderable.setTopBorderStyle(int)

getRightBorderColor

public Color getRightBorderColor()

Specified by:

getRightBorderColor in interface Borderable

Returns:

The Color of the Borderable's right border.

See Also:

Borderable.getRightBorderColor()

getRightBorderSize

public int getRightBorderSize()

Specified by:

getRightBorderSize in interface Borderable

Returns:

The size of the Borderables's right border.

See Also:

Borderable.getRightBorderSize()

getRightBorderStyle

public int getRightBorderStyle()

Specified by:

getRightBorderStyle in interface Borderable

Returns:

The style of the Borderables's right border.

See Also:

Borderable.getRightBorderStyle()

setRightBorderColor

public void setRightBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's right border.

Specified by:

setRightBorderColor in interface Borderable

See Also:

Borderable.setRightBorderColor(nextapp.echo.Color)

setRightBorderSize

public void setRightBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's right border.

Specified by:

setRightBorderSize in interface Borderable

See Also:

Borderable.setRightBorderSize(int)

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's right border.

Specified by:

setRightBorderStyle in interface Borderable

See Also:

Borderable.setRightBorderStyle(int)

getBottomBorderColor

public Color getBottomBorderColor()

Specified by:

getBottomBorderColor in interface Borderable

Returns:

The Color of the Borderable's bottom border.

See Also:

Borderable.getBottomBorderColor()

getBottomBorderSize

public int getBottomBorderSize()

Specified by:

getBottomBorderSize in interface Borderable

Returns:

The size of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderSize()

getBottomBorderStyle

public int getBottomBorderStyle()

Specified by:

getBottomBorderStyle in interface Borderable

Returns:

The style of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's bottom border.

Specified by:

setBottomBorderColor in interface Borderable

See Also:

Borderable.setBottomBorderColor(nextapp.echo.Color)

setBottomBorderSize

public void setBottomBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's bottom border.

Specified by:

setBottomBorderSize in interface Borderable

See Also:

Borderable.setBottomBorderSize(int)

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's bottom border.

Specified by:

setBottomBorderStyle in interface Borderable

See Also:

Borderable.setBottomBorderStyle(int)

setComplexRendering

public void setComplexRendering(boolean newRendering)

Sets whether complex rendering is used by the GroupBox.
Note: the GroupBox will be rendered using a simple style if the client cannot support complex rendering. This will occur regardless of the value of this property.
This methods fires a PropertyChangeEvent with a getPropertyName() value of GroupBox.RENDERING_CHANGED_PROPERTY

setInsets

public void setInsets(Insets newValue)

Sets the Insets used by the GroupBox
This methods fires a PropertyChangeEvent with a getPropertyName() value of GroupBox.INSETS_CHANGED_PROPERTY

setLayoutManager

public void setLayoutManager(LayoutManager newLayoutManager)

Sets a new LayoutManager into the LayoutManageable container.

Specified by:

setLayoutManager in interface LayoutManageable

setTitle

public void setTitle(java.lang.String newValue)

Sets the title of the GroupBox.
This methods fires a PropertyChangeEvent with a getPropertyName() value of GroupBox.TITLE_CHANGED_PROPERTY

setTitleColor

public void setTitleColor(Color newValue)

Sets the titleColor of the GroupBox.
This methods fires a PropertyChangeEvent with a getPropertyName() value of GroupBox.TITLE_COLOR_CHANGED_PROPERTY

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

java.lang.NullPointerException

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)