com.sptci.echo
Class ControlBarWindowPane

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.WindowPane
          com.sptci.echo.WindowPane
              com.sptci.echo.ControlBarWindowPane

All Implemented Interfaces:

View, Serializable, FloatingPane, ModalSupport, Pane, PaneContainer, RenderIdSupport

public class ControlBarWindowPane
extends WindowPane

A base FloatingPane component that displays a control bar at the bottom that can hold controls for the rest of the components displayed in the pane. Use the addControl(nextapp.echo.app.Component) and addContent(nextapp.echo.app.Component) method to add controls to the pane or other UI components to the pane.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: ControlBarWindowPane.java 4553 2008-12-24 10:34:16Z rakesh $

Author:

Rakesh Vidyadharan 2007-09-30

See Also:

Serialized Form

Field Summary

Fields inherited from class nextapp.echo.app.WindowPane

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, INPUT_CLOSE, INPUT_MAXIMIZE, INPUT_MINIMIZE, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_CLOSABLE, PROPERTY_CLOSE_ICON, PROPERTY_CLOSE_ICON_INSETS, PROPERTY_CLOSE_ROLLOVER_ICON, PROPERTY_CONTENT_HEIGHT, PROPERTY_CONTENT_WIDTH, PROPERTY_CONTROLS_INSETS, PROPERTY_CONTROLS_SPACING, PROPERTY_DEFAULT_CLOSE_OPERATION, PROPERTY_HEIGHT, PROPERTY_ICON, PROPERTY_ICON_INSETS, PROPERTY_INSETS, PROPERTY_MAXIMIZE_ENABLED, PROPERTY_MAXIMIZE_ICON, PROPERTY_MAXIMIZE_ICON_INSETS, PROPERTY_MAXIMIZE_ROLLOVER_ICON, PROPERTY_MAXIMUM_HEIGHT, PROPERTY_MAXIMUM_WIDTH, PROPERTY_MINIMIZE_ENABLED, PROPERTY_MINIMIZE_ICON, PROPERTY_MINIMIZE_ICON_INSETS, PROPERTY_MINIMIZE_ROLLOVER_ICON, PROPERTY_MINIMUM_HEIGHT, PROPERTY_MINIMUM_WIDTH, PROPERTY_MOVABLE, PROPERTY_POSITION_X, PROPERTY_POSITION_Y, PROPERTY_RESIZABLE, PROPERTY_TITLE, PROPERTY_TITLE_BACKGROUND, PROPERTY_TITLE_BACKGROUND_IMAGE, PROPERTY_TITLE_FONT, PROPERTY_TITLE_FOREGROUND, PROPERTY_TITLE_HEIGHT, PROPERTY_TITLE_INSETS, PROPERTY_WIDTH, PROPERTY_Z_INDEX

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 nextapp.echo.app.ModalSupport

MODAL_CHANGED_PROPERTY

Constructor Summary

ControlBarWindowPane()
Create a new window pane and initialise the layout for the pane.

Method Summary

void	addContent(Component content) Add the specified content component to the pane.
void	addContent(Component content, int index) Add the specified component component to the pane at the specified index.
void	addControl(Component control) Add the specified control component to the pane.
void	addControl(Component control, int index) Add the specified control component to the pane at the specified index.
void	removeAllContents() Remove all the content components from the pane.
void	removeAllControls() Remove all the control components from the pane.
void	removeContent(Component content) Remove the specified content component from the pane.
void	removeContent(int index) Remove the content component at the specified index from the pane.
void	removeControl(Component control) Remove the specified control component from the pane.
void	removeControl(int index) Remove the control component at the specified index from the pane.

Methods inherited from class com.sptci.echo.WindowPane

init

Methods inherited from class nextapp.echo.app.WindowPane

addWindowPaneListener, fireWindowClosing, fireWindowMaximized, fireWindowMinimized, getBackgroundImage, getBorder, getCloseIcon, getCloseIconInsets, getCloseRolloverIcon, getContentHeight, getContentWidth, getControlsInsets, getControlsSpacing, getDefaultCloseOperation, getHeight, getIcon, getIconInsets, getInsets, getMaximizeIcon, getMaximizeIconInsets, getMaximizeRolloverIcon, getMaximumHeight, getMaximumWidth, getMinimizeIcon, getMinimizeIconInsets, getMinimizeRolloverIcon, getMinimumHeight, getMinimumWidth, getPositionX, getPositionY, getTitle, getTitleBackground, getTitleBackgroundImage, getTitleFont, getTitleForeground, getTitleHeight, getTitleInsets, getWidth, getZIndex, isClosable, isMaximizeEnabled, isMinimizeEnabled, isModal, isMovable, isResizable, isValidChild, isValidParent, processInput, removeWindowPaneListener, setBackgroundImage, setBorder, setClosable, setCloseIcon, setCloseIconInsets, setCloseRolloverIcon, setContentHeight, setContentWidth, setControlsInsets, setControlsSpacing, setDefaultCloseOperation, setHeight, setIcon, setIconInsets, setInsets, setMaximizeEnabled, setMaximizeIcon, setMaximizeIconInsets, setMaximizeRolloverIcon, setMaximumHeight, setMaximumWidth, setMinimizeEnabled, setMinimizeIcon, setMinimizeIconInsets, setMinimizeRolloverIcon, setMinimumHeight, setMinimumWidth, setModal, setMovable, setPositionX, setPositionY, setResizable, setTitle, setTitleBackground, setTitleBackgroundImage, setTitleFont, setTitleForeground, setTitleHeight, setTitleInsets, setWidth, setZIndex, userClose, userMaximize, userMinimize

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, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, 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

Constructor Detail

ControlBarWindowPane

public ControlBarWindowPane()

Create a new window pane and initialise the layout for the pane.

Method Detail

addControl

public void addControl(Component control)

Add the specified control component to the pane.

Parameters:

control - The control component. These are usually Button components.

See Also:

Component.add( Component )

addControl

public void addControl(Component control,
                       int index)

Add the specified control component to the pane at the specified index.

Parameters:

control - The control component. These are usually Button components.

index - The index at which the component is to be added.

See Also:

Component.add( Component, int )

removeControl

public void removeControl(Component control)

Remove the specified control component from the pane.

Parameters:

control - The control component that is to be removed.

See Also:

Component.remove( Component )

removeControl

public void removeControl(int index)

Remove the control component at the specified index from the pane. index.

Parameters:

index - The index of which the component that is to be removed.

See Also:

Component.remove( int )

removeAllControls

public void removeAllControls()

Remove all the control components from the pane.

addContent

public void addContent(Component content)

Add the specified content component to the pane.

Parameters:

content - The content component. These may be layout components such as Row, Column, Grid etc, or componens such as TextField, Label, etc.

See Also:

Component.add( Component )

addContent

public void addContent(Component content,
                       int index)

Add the specified component component to the pane at the specified index.

Parameters:

content - The content component. These may be layout components such as Row, Column, Grid etc, or componens such as TextField, Label, etc.

index - The index at which the component is to be added.

See Also:

Component.add( Component, int )

removeContent

public void removeContent(Component content)

Remove the specified content component from the pane.

Parameters:

content - The content component that is to be removed.

See Also:

Component.remove( Component )

removeContent

public void removeContent(int index)

Remove the content component at the specified index from the pane. index.

Parameters:

index - The index of which the component that is to be removed.

See Also:

Component.remove( int )

removeAllContents

public void removeAllContents()

Remove all the content components from the pane.