echopoint
Class Separator

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

All Implemented Interfaces:

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

public class Separator
extends EchoPointComponent

The Separator class is a Component that provides a simple separator within menus or between other Components

It consists of a top line and bottom line, that can have width and color values. It also has an Inset value around it.

See Also:

Serialized Form

Nested Class Summary

static class

Separator.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	BOTTOM_COLOR_CHANGED_PROPERTY
static java.lang.String	BOTTOM_SIZE_CHANGED_PROPERTY
static Color	DEFAULT_BOTTOM_COLOR the default bottom color
static int	DEFAULT_BOTTOM_SIZE the default bottom size is 1
static Insets	DEFAULT_INSETS the default insets are {4,2}
static Color	DEFAULT_TOP_COLOR the default top color
static int	DEFAULT_TOP_SIZE the default top size is 1
static java.lang.String	INSETS_CHANGED_PROPERTY
static java.lang.String	STYLE_BOTTOM_COLOR A style constant for the BottomColor property.
static java.lang.String	STYLE_BOTTOM_SIZE A style constant for the BottomSize property.
static java.lang.String	STYLE_INSETS A style constant for the Insets property.
static java.lang.String	STYLE_TOP_COLOR A style constant for the TopColor property.
static java.lang.String	STYLE_TOP_SIZE A style constant for the TopSize property.
static java.lang.String	TOP_COLOR_CHANGED_PROPERTY
static java.lang.String	TOP_SIZE_CHANGED_PROPERTY

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

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

Separator()
Constructs a Separator.

Method Summary

void	applyStyle(Style style) Sets stylistic properties of this component based on a Style object.
Color	getBottomColor() The color of the bottom separator line
int	getBottomSize() The size of the bottom separator line
Insets	getInsets() The insets of the separator, spaced as margins around the separator line.
Color	getTopColor() The color of the top separator line
int	getTopSize() The size of the top separator line
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	setBottomColor(Color color)
void	setBottomSize(int i)
void	setInsets(Insets newValue)
void	setTopColor(Color color)
void	setTopSize(int i)

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

add, add, 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, remove, remove, 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_BOTTOM_SIZE

public static final java.lang.String STYLE_BOTTOM_SIZE

A style constant for the BottomSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_BOTTOM_COLOR

public static final java.lang.String STYLE_BOTTOM_COLOR

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

See Also:

Constant Field Values

STYLE_TOP_SIZE

public static final java.lang.String STYLE_TOP_SIZE

A style constant for the TopSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_TOP_COLOR

public static final java.lang.String STYLE_TOP_COLOR

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

See Also:

Constant Field Values

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

DEFAULT_BOTTOM_COLOR

public static final Color DEFAULT_BOTTOM_COLOR

the default bottom color

DEFAULT_INSETS

public static final Insets DEFAULT_INSETS

the default insets are {4,2}

DEFAULT_TOP_COLOR

public static final Color DEFAULT_TOP_COLOR

the default top color

DEFAULT_TOP_SIZE

public static final int DEFAULT_TOP_SIZE

the default top size is 1

See Also:

Constant Field Values

DEFAULT_BOTTOM_SIZE

public static final int DEFAULT_BOTTOM_SIZE

the default bottom size is 1

See Also:

Constant Field Values

INSETS_CHANGED_PROPERTY

public static final java.lang.String INSETS_CHANGED_PROPERTY

See Also:

Constant Field Values

BOTTOM_COLOR_CHANGED_PROPERTY

public static final java.lang.String BOTTOM_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

BOTTOM_SIZE_CHANGED_PROPERTY

public static final java.lang.String BOTTOM_SIZE_CHANGED_PROPERTY

See Also:

Constant Field Values

TOP_COLOR_CHANGED_PROPERTY

public static final java.lang.String TOP_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

TOP_SIZE_CHANGED_PROPERTY

public static final java.lang.String TOP_SIZE_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

Separator

public Separator()

Constructs a Separator.

Method Detail

getBottomColor

public Color getBottomColor()

The color of the bottom separator line

Returns:

The color of the bottom separator line

getBottomSize

public int getBottomSize()

The size of the bottom separator line

Returns:

The size of the bottom separator line

getTopColor

public Color getTopColor()

The color of the top separator line

Returns:

The color of the top separator line

getTopSize

public int getTopSize()

The size of the top separator line

Returns:

The color of the top separator line

setBottomColor

public void setBottomColor(Color color)

Parameters:

color -

setBottomSize

public void setBottomSize(int i)

Parameters:

i -

setTopColor

public void setTopColor(Color color)

Parameters:

color -

setTopSize

public void setTopSize(int i)

Parameters:

i -

getInsets

public Insets getInsets()

The insets of the separator, spaced as margins around the separator line.

Returns:

The insets of the separator

setInsets

public void setInsets(Insets newValue)

Parameters:

newValue -

applyStyle

public void applyStyle(Style style)

Description copied from interface: Component

Sets stylistic properties of this component based on a Style object. The version of this method in Component will set foreground and background colors and the font from the style if they are present. Components should override this method if they allow more properties to be set from a style object, and should call super.applyStyle() if necessary.

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)

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;
 }
 

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)