echopoint.jquery
Class CarouselContainer

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

All Implemented Interfaces:

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

public class CarouselContainer
extends ContainerEx

CarouselContainer is a component that can be positioned anywhere on the screen with an specified size attributes. The components put inside will be able to navigate between in a carousel-style widget. This component is built around the jQuery project jCarousel Lite: http://www.gmarwaha.com/jquery/jcarousellite This component is a PaneContainer and hence can have components that implement Pane as a child.

Version:

$Id$

Author:

HansH 2009-07-09

See Also:

Serialized Form

Field Summary

static String	PROPERTY_CIRCULAR
static String	PROPERTY_LEFT_ICON
static String	PROPERTY_LEFT_ICON_OVER
static String	PROPERTY_RIGHT_ICON
static String	PROPERTY_RIGHT_ICON_OVER
static String	PROPERTY_VISIBLE

Fields inherited from class echopoint.ContainerEx

COLUMN_LAYOUT, DEFAULT_LAYOUT, PROPERTY_HORIZONTAL_SCROLL, PROPERTY_LAYOUT_STYLE, PROPERTY_VERTICAL_SCROLL, 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.Stretchable

PROPERTY_HEIGHT_STRETCHED, PROPERTY_MAXIMUM_STRETCHED_HEIGHT, PROPERTY_MINIMUM_STRETCHED_HEIGHT

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

CarouselContainer()

Method Summary

ImageReference	getLeftIcon() Returns the left icon displayed in the button.
ImageReference	getLeftMouseOverIcon() Returns the left icon displayed in the button.
ImageReference	getRightIcon() Returns the right icon displayed in the button.
ImageReference	getRightMouseOverIcon() Returns the right icon displayed in the button.
int	getVisible() Returns the number of visible items
boolean	isCircular() Returns true if the carousel is circular
void	setCircular(boolean isCircular) Sets whether the carousel should be circular or not
void	setLeftIcon(ImageReference newValue) Sets the left icon displayed in the button.
void	setLeftMouseOverIcon(ImageReference newValue) Sets the left icon displayed in the button.
void	setRightIcon(ImageReference newValue) Sets the right icon displayed in the button.
void	setRightMouseOverIcon(ImageReference newValue) Sets the right icon displayed in the button.
void	setVisible(int newVisible) Sets the number of visible items.

Methods inherited from class echopoint.ContainerEx

clear, getAlignment, getBackgroundImage, getBorder, getBottom, getHeight, getHorizontalScroll, getInsets, getLayoutStyle, getLeft, getMaximumStretchedHeight, getMinimumStretchedHeight, getOutsets, getPosition, getRight, getScrollBarBaseColor, getScrollBarPolicy, getScrollBarProperties, getTop, getVerticalScroll, getWidth, getZIndex, isHeightStretched, isPositioned, processInput, setAlignment, setBackgroundImage, setBorder, setBottom, setHeight, setHeightStretched, setHorizontalScroll, setInsets, setLayoutStyle, setLeft, setMaximumStretchedHeight, setMinimumStretchedHeight, setOutsets, setPosition, setRight, setScrollBarBaseColor, setScrollBarPolicy, setScrollBarProperties, setTop, setVerticalScroll, setWidth, setZIndex

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, 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_LEFT_ICON

public static final String PROPERTY_LEFT_ICON

See Also:

Constant Field Values

PROPERTY_RIGHT_ICON

public static final String PROPERTY_RIGHT_ICON

See Also:

Constant Field Values

PROPERTY_LEFT_ICON_OVER

public static final String PROPERTY_LEFT_ICON_OVER

See Also:

Constant Field Values

PROPERTY_RIGHT_ICON_OVER

public static final String PROPERTY_RIGHT_ICON_OVER

See Also:

Constant Field Values

PROPERTY_VISIBLE

public static final String PROPERTY_VISIBLE

See Also:

Constant Field Values

PROPERTY_CIRCULAR

public static final String PROPERTY_CIRCULAR

See Also:

Constant Field Values

Constructor Detail

CarouselContainer

public CarouselContainer()

Method Detail

getLeftIcon

public ImageReference getLeftIcon()

Returns the left icon displayed in the button.

Returns:

the icon

setLeftIcon

public void setLeftIcon(ImageReference newValue)

Sets the left icon displayed in the button.

Parameters:

newValue - the new icon

getRightIcon

public ImageReference getRightIcon()

Returns the right icon displayed in the button.

Returns:

the icon

setRightIcon

public void setRightIcon(ImageReference newValue)

Sets the right icon displayed in the button.

Parameters:

newValue - the new icon

getLeftMouseOverIcon

public ImageReference getLeftMouseOverIcon()

Returns the left icon displayed in the button.

Returns:

the icon

setLeftMouseOverIcon

public void setLeftMouseOverIcon(ImageReference newValue)

Sets the left icon displayed in the button.

Parameters:

newValue - the new icon

getRightMouseOverIcon

public ImageReference getRightMouseOverIcon()

Returns the right icon displayed in the button.

Returns:

the icon

setRightMouseOverIcon

public void setRightMouseOverIcon(ImageReference newValue)

Sets the right icon displayed in the button.

Parameters:

newValue - the new icon

getVisible

public int getVisible()

Returns the number of visible items

Returns:

setVisible

public void setVisible(int newVisible)

Sets the number of visible items.

Parameters:

newVisible -

isCircular

public boolean isCircular()

Returns true if the carousel is circular

Returns:

setCircular

public void setCircular(boolean isCircular)

Sets whether the carousel should be circular or not

Parameters:

isCircular -