nextapp.echo2.extras.app
Class AccordionPane

java.lang.Object
  nextapp.echo2.app.Component
      nextapp.echo2.extras.app.AccordionPane

All Implemented Interfaces:

java.io.Serializable, nextapp.echo2.app.Pane, nextapp.echo2.app.PaneContainer, nextapp.echo2.app.RenderIdSupport

public class AccordionPane
extends nextapp.echo2.app.Component
implements nextapp.echo2.app.Pane, nextapp.echo2.app.PaneContainer

A PaneContainer which contains multiple panes in vertically arranged tabs that slide up and down to reveal a single child Pane at a time.

See Also:

Serialized Form

Field Summary

static java.lang.String	ACTIVE_TAB_INDEX_CHANGED_PROPERTY
static java.lang.String	INPUT_TAB_INDEX
static java.lang.String	PROPERTY_DEFAULT_CONTENT_INSETS
static java.lang.String	PROPERTY_TAB_BACKGROUND
static java.lang.String	PROPERTY_TAB_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_TAB_BORDER
static java.lang.String	PROPERTY_TAB_FOREGROUND
static java.lang.String	PROPERTY_TAB_INSETS
static java.lang.String	PROPERTY_TAB_ROLLOVER_BACKGROUND
static java.lang.String	PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_TAB_ROLLOVER_BORDER
static java.lang.String	PROPERTY_TAB_ROLLOVER_ENABLED
static java.lang.String	PROPERTY_TAB_ROLLOVER_FOREGROUND

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

Constructor Summary

AccordionPane()
Default constructor.

Method Summary

int	getActiveTabIndex() Returns the index of the active tab.
nextapp.echo2.app.Insets	getDefaultContentInsets() Returns the default content inset margin.
nextapp.echo2.app.Color	getTabBackground() Returns the tab background color.
nextapp.echo2.app.FillImage	getTabBackgroundImage() Returns the tab background image.
nextapp.echo2.app.Border	getTabBorder() Returns the tab border.
nextapp.echo2.app.Color	getTabForeground() Returns the tab foreground color.
nextapp.echo2.app.Insets	getTabInsets() Returns the tab inset margin.
nextapp.echo2.app.Color	getTabRolloverBackground() Returns the tab rollover background color.
nextapp.echo2.app.FillImage	getTabRolloverBackgroundImage() Returns the tab rollover background image.
nextapp.echo2.app.Border	getTabRolloverBorder() Returns the tab rollover border.
nextapp.echo2.app.Color	getTabRolloverForeground() Returns the tab rollover foreground color.
boolean	isTabRolloverEnabled() Determines whether rollover effects are enabled.
boolean	isValidParent(nextapp.echo2.app.Component c)
void	processInput(java.lang.String inputName, java.lang.Object inputValue)
void	setActiveTabIndex(int newValue) Sets the active tab index.
void	setDefaultContentInsets(nextapp.echo2.app.Insets newValue) Sets the default content inset margin.
void	setTabBackground(nextapp.echo2.app.Color newValue) Sets the tab background color.
void	setTabBackgroundImage(nextapp.echo2.app.FillImage newValue) Sets the tab background image.
void	setTabBorder(nextapp.echo2.app.Border newValue) Sets the tab border.
void	setTabForeground(nextapp.echo2.app.Color newValue) Sets the tab foreground color.
void	setTabInsets(nextapp.echo2.app.Insets newValue) Sets the tab inset margin.
void	setTabRolloverBackground(nextapp.echo2.app.Color newValue) Sets the tab rollover background color.
void	setTabRolloverBackgroundImage(nextapp.echo2.app.FillImage newValue) Sets the tab rollover background image.
void	setTabRolloverBorder(nextapp.echo2.app.Border newValue) Sets the tab rollover border.
void	setTabRolloverEnabled(boolean newValue) Sets whether tab rollover effects are enabled.
void	setTabRolloverForeground(nextapp.echo2.app.Color newValue) Sets the tab rollover foreground color.

Methods inherited from class nextapp.echo2.app.Component

add, add, addPropertyChangeListener, 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, isVisible, remove, remove, removeAll, removePropertyChangeListener, 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

Field Detail

INPUT_TAB_INDEX

public static final java.lang.String INPUT_TAB_INDEX

See Also:

Constant Field Values

ACTIVE_TAB_INDEX_CHANGED_PROPERTY

public static final java.lang.String ACTIVE_TAB_INDEX_CHANGED_PROPERTY

See Also:

Constant Field Values

PROPERTY_DEFAULT_CONTENT_INSETS

public static final java.lang.String PROPERTY_DEFAULT_CONTENT_INSETS

See Also:

Constant Field Values

PROPERTY_TAB_BACKGROUND

public static final java.lang.String PROPERTY_TAB_BACKGROUND

See Also:

Constant Field Values

PROPERTY_TAB_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_TAB_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_TAB_BORDER

public static final java.lang.String PROPERTY_TAB_BORDER

See Also:

Constant Field Values

PROPERTY_TAB_FOREGROUND

public static final java.lang.String PROPERTY_TAB_FOREGROUND

See Also:

Constant Field Values

PROPERTY_TAB_INSETS

public static final java.lang.String PROPERTY_TAB_INSETS

See Also:

Constant Field Values

PROPERTY_TAB_ROLLOVER_BACKGROUND

public static final java.lang.String PROPERTY_TAB_ROLLOVER_BACKGROUND

See Also:

Constant Field Values

PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_TAB_ROLLOVER_BORDER

public static final java.lang.String PROPERTY_TAB_ROLLOVER_BORDER

See Also:

Constant Field Values

PROPERTY_TAB_ROLLOVER_ENABLED

public static final java.lang.String PROPERTY_TAB_ROLLOVER_ENABLED

See Also:

Constant Field Values

PROPERTY_TAB_ROLLOVER_FOREGROUND

public static final java.lang.String PROPERTY_TAB_ROLLOVER_FOREGROUND

See Also:

Constant Field Values

Constructor Detail

AccordionPane

public AccordionPane()

Default constructor.

Method Detail

getActiveTabIndex

public int getActiveTabIndex()

Returns the index of the active tab.

Returns:

the active tab index

getDefaultContentInsets

public nextapp.echo2.app.Insets getDefaultContentInsets()

Returns the default content inset margin. This margin is applied by default to each child component.

Returns:

the default content inset margin

getTabBackground

public nextapp.echo2.app.Color getTabBackground()

Returns the tab background color.

Returns:

the tab background color

getTabBackgroundImage

public nextapp.echo2.app.FillImage getTabBackgroundImage()

Returns the tab background image.

Returns:

the tab background image

getTabBorder

public nextapp.echo2.app.Border getTabBorder()

Returns the tab border.

Returns:

the tab border

getTabForeground

public nextapp.echo2.app.Color getTabForeground()

Returns the tab foreground color.

Returns:

the tab foreground color

getTabInsets

public nextapp.echo2.app.Insets getTabInsets()

Returns the tab inset margin.

Returns:

the tab inset margin

getTabRolloverBackground

public nextapp.echo2.app.Color getTabRolloverBackground()

Returns the tab rollover background color.

Returns:

the tab rollover background color

getTabRolloverBackgroundImage

public nextapp.echo2.app.FillImage getTabRolloverBackgroundImage()

Returns the tab rollover background image.

Returns:

the tab rollover background image

getTabRolloverBorder

public nextapp.echo2.app.Border getTabRolloverBorder()

Returns the tab rollover border.

Returns:

the tab rollover border

isTabRolloverEnabled

public boolean isTabRolloverEnabled()

Determines whether rollover effects are enabled. Default value is true.

Returns:

true if rollover effects should be enabled.

getTabRolloverForeground

public nextapp.echo2.app.Color getTabRolloverForeground()

Returns the tab rollover foreground color.

Returns:

the tab rollover foreground color

isValidParent

public boolean isValidParent(nextapp.echo2.app.Component c)

Overrides:

isValidParent in class nextapp.echo2.app.Component

See Also:

Component.isValidParent(nextapp.echo2.app.Component)

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Overrides:

processInput in class nextapp.echo2.app.Component

See Also:

Component.processInput(java.lang.String, java.lang.Object)

setActiveTabIndex

public void setActiveTabIndex(int newValue)

Sets the active tab index.

Parameters:

newValue - the index of the child Component whose tab should be displayed

setDefaultContentInsets

public void setDefaultContentInsets(nextapp.echo2.app.Insets newValue)

Sets the default content inset margin. This margin is applied by default to each child component.

Parameters:

newValue - the new default content inset margin

setTabBackground

public void setTabBackground(nextapp.echo2.app.Color newValue)

Sets the tab background color.

Parameters:

newValue - the new tab background color

setTabBackgroundImage

public void setTabBackgroundImage(nextapp.echo2.app.FillImage newValue)

Sets the tab background image.

Parameters:

newValue - the new tab background image

setTabBorder

public void setTabBorder(nextapp.echo2.app.Border newValue)

Sets the tab border.

Parameters:

newValue - the new tab border

setTabForeground

public void setTabForeground(nextapp.echo2.app.Color newValue)

Sets the tab foreground color.

Parameters:

newValue - the new tab foreground color

setTabInsets

public void setTabInsets(nextapp.echo2.app.Insets newValue)

Sets the tab inset margin.

Parameters:

newValue - the new tab inset margin

setTabRolloverBackground

public void setTabRolloverBackground(nextapp.echo2.app.Color newValue)

Sets the tab rollover background color.

Parameters:

newValue - the new tab rollover background color

setTabRolloverBackgroundImage

public void setTabRolloverBackgroundImage(nextapp.echo2.app.FillImage newValue)

Sets the tab rollover background image.

Parameters:

newValue - the new tab rollover background image

setTabRolloverBorder

public void setTabRolloverBorder(nextapp.echo2.app.Border newValue)

Sets the tab rollover border.

Parameters:

newValue - the new tab rollover border

setTabRolloverEnabled

public void setTabRolloverEnabled(boolean newValue)

Sets whether tab rollover effects are enabled.

Parameters:

newValue - thew new rollover effect state

setTabRolloverForeground

public void setTabRolloverForeground(nextapp.echo2.app.Color newValue)

Sets the tab rollover foreground color.

Parameters:

newValue - the new tab rollover foreground color