echopoint
Class Separator

java.lang.Object
  nextapp.echo.app.Component
      echopoint.ComponentEx
          echopoint.Separator

All Implemented Interfaces:

Attributeable, Delegateable, Insetable, Serializable, RenderIdSupport

public class Separator
extends ComponentEx
implements Insetable

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.

Version:

$Id: Separator.java 208 2009-05-25 02:40:35Z sptrakesh $

Author:

Brad Baker

Modified by HansH 2009-04-03

See Also:

Serialized Form

Field Summary

static Color	DEFAULT_BOTTOM_COLOR the default bottom color
static Extent	DEFAULT_BOTTOM_SIZE the default bottom size is 1
static Insets	DEFAULT_INSETS the default insets are {4,2}
static Style	DEFAULT_STYLE
static Color	DEFAULT_TOP_COLOR the default top color
static Extent	DEFAULT_TOP_SIZE the default top size is 1
static String	PROPERTY_BOTTOM_COLOR
static String	PROPERTY_BOTTOM_SIZE
static String	PROPERTY_TOP_COLOR
static String	PROPERTY_TOP_SIZE

Fields inherited from class echopoint.ComponentEx

PROPERTY_HIDDEN

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface echopoint.able.Insetable

DEFAULT_OUTSETS, PROPERTY_INSETS, PROPERTY_OUTSETS

Constructor Summary

Separator()
Constructs a Separator.

Method Summary

Color	getBottomColor() The color of the bottom separator line
Extent	getBottomSize() The size of the bottom separator line
Insets	getInsets()
Insets	getOutsets()
Color	getTopColor() The color of the top separator line
Extent	getTopSize() The size of the top separator line
void	setBottomColor(Color color)
void	setBottomSize(Extent newValue)
void	setInsets(Insets newValue) Sets the Insets in play.
void	setOutsets(Insets newValue) Sets the Outsets in play.
void	setTopColor(Color newValue)
void	setTopSize(Extent newValue)

Methods inherited from class echopoint.ComponentEx

get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttribute, getAttributeNames, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, isHidden, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setAttribute, setHidden

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface echopoint.able.Delegateable

getRenderProperty, getRenderProperty

Field Detail

PROPERTY_BOTTOM_SIZE

public static final String PROPERTY_BOTTOM_SIZE

See Also:

Constant Field Values

PROPERTY_BOTTOM_COLOR

public static final String PROPERTY_BOTTOM_COLOR

See Also:

Constant Field Values

PROPERTY_TOP_SIZE

public static final String PROPERTY_TOP_SIZE

See Also:

Constant Field Values

PROPERTY_TOP_COLOR

public static final String PROPERTY_TOP_COLOR

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 Extent DEFAULT_TOP_SIZE

the default top size is 1

DEFAULT_BOTTOM_SIZE

public static final Extent DEFAULT_BOTTOM_SIZE

the default bottom size is 1

DEFAULT_STYLE

public static final Style DEFAULT_STYLE

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

The size of the top separator line

Returns:

The color of the top separator line

setBottomColor

public void setBottomColor(Color color)

setBottomSize

public void setBottomSize(Extent newValue)

setTopColor

public void setTopColor(Color newValue)

setTopSize

public void setTopSize(Extent newValue)

getInsets

public Insets getInsets()

Specified by:

getInsets in interface Insetable

Returns:

the Insets in use or null if here are none

See Also:

Insetable.getInsets()

getOutsets

public Insets getOutsets()

Specified by:

getOutsets in interface Insetable

Returns:

the Outsets in use or null if here are none

See Also:

Insetable.getOutsets()

setInsets

public void setInsets(Insets newValue)

Description copied from interface: Insetable

Sets the Insets in play. The Insets control the extra space around the content of a container.

Specified by:

setInsets in interface Insetable

Parameters:

newValue - - the Insets to use

See Also:

Insetable.setInsets(nextapp.echo.app.Insets)

setOutsets

public void setOutsets(Insets newValue)

Description copied from interface: Insetable

Sets the Outsets in play. The Outsets control the extra space around the outside of a container.

Specified by:

setOutsets in interface Insetable

Parameters:

newValue - - the Ousets to use

See Also:

Insetable.setOutsets(nextapp.echo.app.Insets)