echopointng
Class AbleComponent

java.lang.Object
  nextapp.echo2.app.Component
      echopointng.ComponentEx
          echopointng.AbleComponent

All Implemented Interfaces:

AccessKeyable, Attributeable, Borderable, Delegateable, Heightable, Insetable, MouseCursorable, Sizeable, ToolTipable, Widthable, Serializable, RenderIdSupport

Direct Known Subclasses:

AbleProperties, Calculator, ColorChooser, ContainerEx, DateChooser, ExpandableSection, GroupBox, ImageIcon, ImageMap, ListSection, PopUp, ProgressBar, Slider, Strut, TabbedPane, TemplatePanel, TitleBar, Tree

public abstract class AbleComponent
extends ComponentEx
implements AccessKeyable, Borderable, MouseCursorable, Insetable, Sizeable, ToolTipable

AbleComponent is an abstract Component that implements a number of the 'able interfaces and serves as the base for other components

See Also:

Serialized Form

Field Summary

Fields inherited from class echopointng.ComponentEx

PROPERTY_HIDDEN

Fields inherited from class nextapp.echo2.app.Component

CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_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 echopointng.able.AccessKeyable

PROPERTY_ACCESS_KEY

Fields inherited from interface echopointng.able.Borderable

PROPERTY_BORDER

Fields inherited from interface echopointng.able.MouseCursorable

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, PROPERTY_MOUSE_CURSOR, PROPERTY_MOUSE_CURSOR_URI

Fields inherited from interface echopointng.able.Insetable

DEFAULT_INSETS, DEFAULT_OUTSETS, PROPERTY_INSETS, PROPERTY_OUTSETS

Fields inherited from interface echopointng.able.Widthable

PROPERTY_WIDTH

Fields inherited from interface echopointng.able.Heightable

PROPERTY_HEIGHT

Fields inherited from interface echopointng.able.ToolTipable

PROPERTY_TOOL_TIP_TEXT

Constructor Summary

AbleComponent()

Method Summary

String	getAccessKey() Returns the access key in use.
Border	getBorder()
Extent	getHeight() Retutns the height extent of the Heightable.
Insets	getInsets()
int	getMouseCursor() Returns the current mouse cursor in use.
String	getMouseCursorUri()
Insets	getOutsets()
String	getToolTipText() Returns the tool tip text (displayed when the mouse cursor is hovered over the ToolTipable).
Extent	getWidth() Returns the width extent of the Widthable.
void	setAccessKey(String newValue) Sets the access key to be used.
void	setBorder(Border newValue) Sets the Border to be used by the Borderable
void	setHeight(Extent newValue) Sets the height extent of the Heightable.
void	setInsets(Insets newValue) Sets the Insets in play.
void	setMouseCursor(int mouseCursor) Sets the mouse cursor to use.
void	setMouseCursorUri(String mouseCursorURI) Sets the URI to a custom platform mouse cursor.
void	setOutsets(Insets newValue) Sets the Outsets in play.
void	setToolTipText(String newValue) Sets the tool tip text (displayed when the mouse cursor is hovered over the ToolTipable).
void	setWidth(Extent newValue) Sets the width extent of the Widthable.

Methods inherited from class echopointng.ComponentEx

getAttribute, getAttributeNames, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, isHidden, setAttribute, setHidden, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class nextapp.echo2.app.Component

add, add, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, 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, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, 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 echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Constructor Detail

AbleComponent

public AbleComponent()

Method Detail

getAccessKey

public String getAccessKey()

Description copied from interface: AccessKeyable

Returns the access key in use.

Specified by:

getAccessKey in interface AccessKeyable

Returns:

the access key in use.

See Also:

AccessKeyable.getAccessKey()

getBorder

public Border getBorder()

Specified by:

getBorder in interface Borderable

Returns:

The Border of the Borderable.

See Also:

Borderable.getBorder()

getHeight

public Extent getHeight()

Description copied from interface: Heightable

Retutns the height extent of the Heightable.

Specified by:

getHeight in interface Heightable

Returns:

the height extent of the Heightable.

See Also:

Heightable.getHeight()

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

getMouseCursor

public int getMouseCursor()

Description copied from interface: MouseCursorable

Returns the current mouse cursor in use. This will be one of the following values.

• CURSOR_DEFAULT
• CURSOR_AUTO
• CURSOR_CROSSHAIR
• CURSOR_POINTER
• CURSOR_MOVE
• CURSOR_E_RESIZE
• CURSOR_NE_RESIZE
• CURSOR_NW_RESIZE
• CURSOR_N_RESIZE
• CURSOR_SE_RESIZE
• CURSOR_SW_RESIZE
• CURSOR_S_RESIZE
• CURSOR_W_RESIZE
• CURSOR_TEXT
• CURSOR_WAIT
• CURSOR_HELP
• CURSOR_CUSTOM

Specified by:

getMouseCursor in interface MouseCursorable

Returns:

The current mouse cursor in use.

See Also:

MouseCursorable.getMouseCursor()

getMouseCursorUri

public String getMouseCursorUri()

Specified by:

getMouseCursorUri in interface MouseCursorable

Returns:

The custom URI for the mouse cursor or null

See Also:

MouseCursorable.getMouseCursorUri()

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

getWidth

public Extent getWidth()

Description copied from interface: Widthable

Returns the width extent of the Widthable.

Specified by:

getWidth in interface Widthable

Returns:

the width extent of the Widthable.

See Also:

Widthable.getWidth()

setAccessKey

public void setAccessKey(String newValue)

Description copied from interface: AccessKeyable

Sets the access key to be used.

Specified by:

setAccessKey in interface AccessKeyable

Parameters:

newValue - - the access key to be used.

See Also:

AccessKeyable.setAccessKey(java.lang.String)

setBorder

public void setBorder(Border newValue)

Description copied from interface: Borderable

Sets the Border to be used by the Borderable

Specified by:

setBorder in interface Borderable

Parameters:

newValue - - the new Border to use

See Also:

Borderable.setBorder(nextapp.echo2.app.Border)

setHeight

public void setHeight(Extent newValue)

Description copied from interface: Heightable

Sets the height extent of the Heightable.

Specified by:

setHeight in interface Heightable

Parameters:

newValue - - the new height extent of the Heightable

See Also:

Heightable.setHeight(nextapp.echo2.app.Extent)

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.echo2.app.Insets)

setMouseCursor

public void setMouseCursor(int mouseCursor)

Description copied from interface: MouseCursorable

Sets the mouse cursor to use. This will be one of the following values.

• CURSOR_DEFAULT
• CURSOR_AUTO
• CURSOR_CROSSHAIR
• CURSOR_POINTER
• CURSOR_MOVE
• CURSOR_E_RESIZE
• CURSOR_NE_RESIZE
• CURSOR_NW_RESIZE
• CURSOR_N_RESIZE
• CURSOR_SE_RESIZE
• CURSOR_SW_RESIZE
• CURSOR_S_RESIZE
• CURSOR_W_RESIZE
• CURSOR_TEXT
• CURSOR_WAIT
• CURSOR_HELP
• CURSOR_CUSTOM

Specified by:

setMouseCursor in interface MouseCursorable

Parameters:

mouseCursor - - the mouse cursor to use

See Also:

MouseCursorable.setMouseCursor(int)

setMouseCursorUri

public void setMouseCursorUri(String mouseCursorURI)

Description copied from interface: MouseCursorable

Sets the URI to a custom platform mouse cursor. This will only be used if the mosue cusor is set to CURSOR_CUSTOM.

Specified by:

setMouseCursorUri in interface MouseCursorable

Parameters:

mouseCursorURI - the URI to a custom platform mouse cursor.

See Also:

MouseCursorable.setMouseCursorUri(java.lang.String)

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.echo2.app.Insets)

setWidth

public void setWidth(Extent newValue)

Description copied from interface: Widthable

Sets the width extent of the Widthable.

Specified by:

setWidth in interface Widthable

Parameters:

newValue - - the new width extent of the Widthable

See Also:

Widthable.setWidth(nextapp.echo2.app.Extent)

getToolTipText

public String getToolTipText()

Description copied from interface: ToolTipable

Returns the tool tip text (displayed when the mouse cursor is hovered over the ToolTipable).

Specified by:

getToolTipText in interface ToolTipable

Returns:

the tool tip text

See Also:

ToolTipable.getToolTipText()

setToolTipText

public void setToolTipText(String newValue)

Description copied from interface: ToolTipable

Sets the tool tip text (displayed when the mouse cursor is hovered over the ToolTipable).

Specified by:

setToolTipText in interface ToolTipable

Parameters:

newValue - the new tool tip text

See Also:

ToolTipable.setToolTipText(java.lang.String)