echopoint.jquery
Class SlidingMenu

java.lang.Object
  nextapp.echo.app.Component
      echopoint.ComponentEx
          echopoint.AbleComponent
              echopoint.jquery.SlidingMenu

All Implemented Interfaces:

AccessKeyable, Alignable, Attributeable, BackgroundImageable, Borderable, Delegateable, Heightable, Insetable, MouseCursorable, Positionable, Scrollable, Sizeable, ToolTipable, Widthable, Serializable, PaneContainer, RenderIdSupport

public class SlidingMenu
extends AbleComponent
implements Alignable, PaneContainer, Positionable, Scrollable, BackgroundImageable

SlidingMenu consists of three parts, a button and two containers. If you press the button the menu slides between the two containers (so one container is always hidden by the other).

Version:

$Id: SlidingMenu.java 189 2009-05-11 13:46:42Z hansho $

Author:

Hans Holmlund - 2009-05-11

See Also:

Serialized Form

Field Summary

static int	COLUMN_LAYOUT
static int	DEFAULT_LAYOUT
static String	PROPERTY_BUTTON_WIDTH
static String	PROPERTY_ICON
static String	PROPERTY_PRESSED_ICON
static String	PROPERTY_ROLLOVER_ICON
static String	PROPERTY_SLIDER_WIDTH
static int	ROW_LAYOUT

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.Alignable

PROPERTY_ALIGNMENT

Fields inherited from interface echopoint.able.Positionable

ABSOLUTE, FIXED, PROPERTY_BOTTOM, PROPERTY_LEFT, PROPERTY_POSITION, PROPERTY_RIGHT, PROPERTY_TOP, PROPERTY_Z_INDEX, RELATIVE, STATIC

Fields inherited from interface echopoint.able.Scrollable

ALWAYS, AUTO, CLIPHIDE, NEVER, PROPERTY_SCROLL_BAR_BASE_COLOR, PROPERTY_SCROLL_BAR_POLICY, PROPERTY_SCROLL_BAR_PROPERTIES, UNDEFINED

Fields inherited from interface echopoint.able.Widthable

PROPERTY_WIDTH

Fields inherited from interface echopoint.able.Heightable

PROPERTY_HEIGHT

Fields inherited from interface echopoint.able.BackgroundImageable

PROPERTY_BACKGROUND_IMAGE

Fields inherited from interface echopoint.able.AccessKeyable

PROPERTY_ACCESS_KEY

Fields inherited from interface echopoint.able.Borderable

PROPERTY_BORDER

Fields inherited from interface echopoint.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 echopoint.able.Insetable

DEFAULT_INSETS, DEFAULT_OUTSETS, PROPERTY_INSETS, PROPERTY_OUTSETS

Fields inherited from interface echopoint.able.ToolTipable

PROPERTY_TOOL_TIP_TEXT

Constructor Summary

SlidingMenu()
Creates a new ContentPane.

Method Summary

void	clear() This sets all the positioning attributes (left,top,right,bottom,z-index) to null or zero.
Alignment	getAlignment() Returns the alignment of the container.
FillImage	getBackgroundImage() Returns the background image.
Border	getBorder() Returns the Border that encloses the entire Clock.
Extent	getBottom() Returns the bottom Y position of the component
Extent	getButtonWidth() Returns the button width
Extent	getHeight() Returns the height extent of container.
ImageReference	getIcon() Returns the icon displayed in the button.
Insets	getInsets() Returns the inset margin of the content.
Extent	getLeft() Returns the left X position of the component
Insets	getOutsets()
int	getPosition() This can be one of : POSITIONING_STATIC POSITIONING_RELATIVE POSITIONING_ABSOLUTE POSITIONING_FIXED
ImageReference	getPressedIcon() Returns the icon of the button that is displayed when the button is pressed.
Extent	getRight() Returns the right X position of the component
ImageReference	getRolloverIcon() Returns the icon of the button that is displayed when the mouse cursor is inside its bounds.
Color	getScrollBarBaseColor() todo Returns the base color of the ScrollBarProperties associated with this Scrollable
int	getScrollBarPolicy() Returns the ScrollBarPolicy in place This can be one of : NONE ALWAYS AUTO CLIPHIDE
ScrollBarProperties	getScrollBarProperties() todo Returns the ScrollBarProperties associated with this Scrollable
Extent	getTop() Returns the top Y position of the component
Extent	getWidth() Returns the width extent of the container.
int	getZIndex() Returns the z-index of the component
boolean	isPositioned() This returns true if any positioning is in place other than normal flow ie.
void	setAlignment(Alignment newValue) Sets the alignment of the container.
void	setBackgroundImage(FillImage newValue) Sets the background image.
void	setBorder(Border newValue) Sets the Border that encloses the entire Clock.
void	setBottom(Extent newValue) Sets the bottom Y position of the component
void	setButtonWidth(Extent newValue) Sets the button width
void	setHeight(Extent newValue) Sets the height extent of the container.
void	setIcon(ImageReference newValue) Sets the icon displayed in the button.
void	setInsets(Insets newValue) Sets the inset margin of the content.
void	setLeft(Extent newValue) Set the left X position of the component
void	setOutsets(Insets newValue) Sets the Outsets in play.
void	setPosition(int newPositioning) Sets the position of the component This can be one of : POSITIONING_STATIC POSITIONING_RELATIVE POSITIONING_ABSOLUTE POSITIONING_FIXED
void	setPressedIcon(ImageReference newValue) Sets the icon of the button that is displayed when the button is pressed.
void	setRight(Extent newValue) Sets the right X position of the component
void	setRolloverIcon(ImageReference newValue) Sets the icon of the button that is displayed when the mouse cursor is inside its bounds.
void	setScrollBarBaseColor(Color newValue) todo Sets the base color of the ScrollBarProperties associated with this Scrollable.
void	setScrollBarPolicy(int newScrollBarPolicy) Sets the scroll bar policy of the component This can be one of : SCOLLBARS_NONE SCOLLBARS_ALWAYS SCOLLBARS_AUTO CLIPHIDE
void	setScrollBarProperties(ScrollBarProperties newValue) todo Sets the ScrollBarProperties associated with this Scrollable
void	setTop(Extent newValue) Sets the top Y position of the component
void	setWidth(Extent newValue) Sets the width extent of the container.
void	setZIndex(int newValue) Sets the z-index of the component

Methods inherited from class echopoint.AbleComponent

getAccessKey, getMouseCursor, getMouseCursorUri, getToolTipText, setAccessKey, setMouseCursor, setMouseCursorUri, setToolTipText

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_ICON

public static final String PROPERTY_ICON

See Also:

Constant Field Values

PROPERTY_PRESSED_ICON

public static final String PROPERTY_PRESSED_ICON

See Also:

Constant Field Values

PROPERTY_ROLLOVER_ICON

public static final String PROPERTY_ROLLOVER_ICON

See Also:

Constant Field Values

PROPERTY_BUTTON_WIDTH

public static final String PROPERTY_BUTTON_WIDTH

See Also:

Constant Field Values

PROPERTY_SLIDER_WIDTH

public static final String PROPERTY_SLIDER_WIDTH

See Also:

Constant Field Values

DEFAULT_LAYOUT

public static final int DEFAULT_LAYOUT

See Also:

Constant Field Values

COLUMN_LAYOUT

public static final int COLUMN_LAYOUT

See Also:

Constant Field Values

ROW_LAYOUT

public static final int ROW_LAYOUT

See Also:

Constant Field Values

Constructor Detail

SlidingMenu

public SlidingMenu()

Creates a new ContentPane.

Method Detail

clear

public void clear()

This sets all the positioning attributes (left,top,right,bottom,z-index) to null or zero.

Specified by:

clear in interface Positionable

getBottom

public Extent getBottom()

Returns the bottom Y position of the component

Specified by:

getBottom in interface Positionable

getLeft

public Extent getLeft()

Returns the left X position of the component

Specified by:

getLeft in interface Positionable

getPosition

public int getPosition()

This can be one of :

• POSITIONING_STATIC
• POSITIONING_RELATIVE
• POSITIONING_ABSOLUTE
• POSITIONING_FIXED

Specified by:

getPosition in interface Positionable

getRight

public Extent getRight()

Returns the right X position of the component

Specified by:

getRight in interface Positionable

getTop

public Extent getTop()

Returns the top Y position of the component

Specified by:

getTop in interface Positionable

getZIndex

public int getZIndex()

Returns the z-index of the component

Specified by:

getZIndex in interface Positionable

isPositioned

public boolean isPositioned()

This returns true if any positioning is in place other than normal flow ie. STATIC.

Specified by:

isPositioned in interface Positionable

setBottom

public void setBottom(Extent newValue)

Sets the bottom Y position of the component

Specified by:

setBottom in interface Positionable

setLeft

public void setLeft(Extent newValue)

Set the left X position of the component

Specified by:

setLeft in interface Positionable

setPosition

public void setPosition(int newPositioning)

Sets the position of the component This can be one of :

• POSITIONING_STATIC
• POSITIONING_RELATIVE
• POSITIONING_ABSOLUTE
• POSITIONING_FIXED

Specified by:

setPosition in interface Positionable

setRight

public void setRight(Extent newValue)

Sets the right X position of the component

Specified by:

setRight in interface Positionable

setTop

public void setTop(Extent newValue)

Sets the top Y position of the component

Specified by:

setTop in interface Positionable

setZIndex

public void setZIndex(int newValue)

Sets the z-index of the component

Specified by:

setZIndex in interface Positionable

getBorder

public Border getBorder()

Returns the Border that encloses the entire Clock.

Specified by:

getBorder in interface Borderable

Overrides:

getBorder in class AbleComponent

Returns:

the border

See Also:

Borderable.getBorder()

setBorder

public void setBorder(Border newValue)

Sets the Border that encloses the entire Clock.

Specified by:

setBorder in interface Borderable

Overrides:

setBorder in class AbleComponent

Parameters:

newValue - the new border

See Also:

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

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image.

Specified by:

getBackgroundImage in interface BackgroundImageable

Returns:

the background image

getInsets

public Insets getInsets()

Returns the inset margin of the content. Note that FloatingPanes, such as WindowPanes, will NOT be constrained by this margin. Values may only be specified in pixel-based units.

Specified by:

getInsets in interface Insetable

Overrides:

getInsets in class AbleComponent

Returns:

newValue the inset margin

See Also:

Insetable.getInsets()

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image.

Specified by:

setBackgroundImage in interface BackgroundImageable

Parameters:

newValue - the new background image

setInsets

public void setInsets(Insets newValue)

Sets the inset margin of the content. Note that FloatingPanes, such as WindowPanes, will NOT be constrained by this margin. Values may only be specified in pixel-based units.

Specified by:

setInsets in interface Insetable

Overrides:

setInsets in class AbleComponent

Parameters:

newValue - the new inset margin

See Also:

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

getHeight

public Extent getHeight()

Returns the height extent of container.

Specified by:

getHeight in interface Heightable

Overrides:

getHeight in class AbleComponent

Returns:

the height extent of container.

See Also:

Heightable.getHeight()

getOutsets

public Insets getOutsets()

Specified by:

getOutsets in interface Insetable

Overrides:

getOutsets in class AbleComponent

Returns:

the Outsets in use or null if here are none

See Also:

Insetable.getOutsets()

getWidth

public Extent getWidth()

Returns the width extent of the container.

Specified by:

getWidth in interface Widthable

Overrides:

getWidth in class AbleComponent

Returns:

the width extent of the container.

See Also:

Widthable.getWidth()

setHeight

public void setHeight(Extent newValue)

Sets the height extent of the container.

Specified by:

setHeight in interface Heightable

Overrides:

setHeight in class AbleComponent

Parameters:

newValue - - the new height extent of the container

See Also:

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

setOutsets

public void setOutsets(Insets newValue)

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

Specified by:

setOutsets in interface Insetable

Overrides:

setOutsets in class AbleComponent

Parameters:

newValue - - the Ousets to use

See Also:

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

setWidth

public void setWidth(Extent newValue)

Sets the width extent of the container.

Specified by:

setWidth in interface Widthable

Overrides:

setWidth in class AbleComponent

Parameters:

newValue - - the new width extent of the container

See Also:

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

getScrollBarPolicy

public int getScrollBarPolicy()

Returns the ScrollBarPolicy in place This can be one of :

• NONE
• ALWAYS
• AUTO
• CLIPHIDE

Specified by:

getScrollBarPolicy in interface Scrollable

getScrollBarBaseColor

public Color getScrollBarBaseColor()

todo Returns the base color of the ScrollBarProperties associated with this Scrollable

Specified by:

getScrollBarBaseColor in interface Scrollable

Returns:

the base color of the ScrollBarProperties associated with this Scrollable

getScrollBarProperties

public ScrollBarProperties getScrollBarProperties()

todo Returns the ScrollBarProperties associated with this Scrollable

Specified by:

getScrollBarProperties in interface Scrollable

Returns:

the ScrollBarProperties associated with this Scrollable

setScrollBarPolicy

public void setScrollBarPolicy(int newScrollBarPolicy)

Sets the scroll bar policy of the component This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO
• CLIPHIDE

Specified by:

setScrollBarPolicy in interface Scrollable

setScrollBarBaseColor

public void setScrollBarBaseColor(Color newValue)

todo Sets the base color of the ScrollBarProperties associated with this Scrollable. If no ScrollBarProperties is available, then a new one should be created.

Specified by:

setScrollBarBaseColor in interface Scrollable

Parameters:

newValue - - the new base color of ScrollBarProperties to use

setScrollBarProperties

public void setScrollBarProperties(ScrollBarProperties newValue)

todo Sets the ScrollBarProperties associated with this Scrollable

Specified by:

setScrollBarProperties in interface Scrollable

Parameters:

newValue - - the new ScrollBarProperties to use

getAlignment

public Alignment getAlignment()

Returns the alignment of the container.

Specified by:

getAlignment in interface Alignable

Returns:

the alignment

setAlignment

public void setAlignment(Alignment newValue)

Sets the alignment of the container.

Specified by:

setAlignment in interface Alignable

Parameters:

newValue - the new alignment

getIcon

public ImageReference getIcon()

Returns the icon displayed in the button.

Returns:

the icon

setIcon

public void setIcon(ImageReference newValue)

Sets the icon displayed in the button.

Parameters:

newValue - the new icon

setPressedIcon

public void setPressedIcon(ImageReference newValue)

Sets the icon of the button that is displayed when the button is pressed.

Parameters:

newValue - the new icon

setRolloverIcon

public void setRolloverIcon(ImageReference newValue)

Sets the icon of the button that is displayed when the mouse cursor is inside its bounds.

Parameters:

newValue - the new icon

getPressedIcon

public ImageReference getPressedIcon()

Returns the icon of the button that is displayed when the button is pressed.

Returns:

the icon

getRolloverIcon

public ImageReference getRolloverIcon()

Returns the icon of the button that is displayed when the mouse cursor is inside its bounds.

Returns:

the icon

getButtonWidth

public Extent getButtonWidth()

Returns the button width

setButtonWidth

public void setButtonWidth(Extent newValue)

Sets the button width

Parameters:

newValue - the new button width