com.vaadin.terminal.gwt.client.ui.


Class VAccordion

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.ComplexPanel
                  com.vaadin.terminal.gwt.client.ui.VAccordion

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Container, ContainerResizedListener, Paintable, Iterable<com.google.gwt.user.client.ui.Widget>

public class VAccordion
extends com.google.gwt.user.client.ui.ComplexPanel
implements ContainerResizedListener

Nested Class Summary
protected  class VAccordion.StackItem
           
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel
com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
 
Field Summary
protected  int activeTabIndex
           
protected  boolean cachedUpdate
           
static String CLASSNAME
           
protected  boolean disabled
           
protected  Set<String> disabledTabKeys
           
protected  boolean readonly
           
static String TAB_STYLE_NAME
           
protected  ArrayList<String> tabKeys
           
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
VAccordion()
           
 
Method Summary
protected  void clearPaintables()
          Clears current tabs and contents
 RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)
          Returns the size currently allocated for the child component.
protected  Iterator<Object> getPaintableIterator()
           
protected  Paintable getTab(int index)
          Implement in extending classes.
protected  int getTabCount()
          Implement in extending classes.
 boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)
          Is a given component child of this layout.
 void iLayout()
          This function is run when container box has been resized.
 boolean isDynamicHeight()
           
 boolean isDynamicWidth()
           
 void onSelectTab(VAccordion.StackItem item)
           
protected  void removeTab(int index)
          Implement in extending classes.
protected  void renderTab(UIDL tabUidl, int index, boolean selected, boolean hidden)
          Implement in extending classes.
 void replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent, com.google.gwt.user.client.ui.Widget newComponent)
          Replace child of this layout with another component.
 boolean requestLayout(Set<Paintable> child)
          Called when a child components size has been updated in the rendering phase.
protected  void selectTab(int index, UIDL contentUidl)
          Implement in extending classes.
 void setHeight(String height)
           
 void setWidth(String width)
           
 void updateCaption(Paintable component, UIDL uidl)
          Update child components caption, description and error message.
 void updateFromUIDL(UIDL uidl, ApplicationConnection client)
           
 
Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
add, add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

TAB_STYLE_NAME

public static final String TAB_STYLE_NAME

See Also:

Constant Field Values

tabKeys

protected final ArrayList<String> tabKeys

activeTabIndex

protected int activeTabIndex

disabled

protected boolean disabled

readonly

protected boolean readonly

disabledTabKeys

protected Set<String> disabledTabKeys

cachedUpdate

protected boolean cachedUpdate
Constructor Detail

VAccordion

public VAccordion()

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:
updateFromUIDL in interface Paintable

renderTab

protected void renderTab(UIDL tabUidl,
                         int index,
                         boolean selected,
                         boolean hidden)

Implement in extending classes. This method should render needed elements and set the visibility of the tab according to the 'selected' parameter.

selectTab

protected void selectTab(int index,
                         UIDL contentUidl)

Implement in extending classes. This method should render any previously non-cached content and set the activeTabIndex property to the specified index.

onSelectTab

public void onSelectTab(VAccordion.StackItem item)

setWidth

public void setWidth(String width)

Overrides:
setWidth in class com.google.gwt.user.client.ui.UIObject

setHeight

public void setHeight(String height)

Overrides:
setHeight in class com.google.gwt.user.client.ui.UIObject

iLayout

public void iLayout()

Description copied from interface: ContainerResizedListener

This function is run when container box has been resized. Object implementing ContainerResizedListener is responsible to call the same function on its ancestors that implement NeedsLayout in case their container has resized. runAnchestorsLayout(HasWidgets parent) function from Util class may be a good helper for this.

Specified by:
iLayout in interface ContainerResizedListener

clearPaintables

protected void clearPaintables()

Clears current tabs and contents

isDynamicHeight

public boolean isDynamicHeight()

isDynamicWidth

public boolean isDynamicWidth()

getPaintableIterator

protected Iterator<Object> getPaintableIterator()

Returns:
a list of currently shown Paintables Apparently can be something else than Paintable as updateFromUIDL(UIDL, ApplicationConnection) checks if instanceof Paintable. Therefore set to

hasChildComponent

public boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)
Description copied from interface: Container
Is a given component child of this layout.

Specified by:
hasChildComponent in interface Container
Parameters:
component - Component to test.
Returns:
true iff component is a child of this layout.

replaceChildComponent

public void replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent,
                                  com.google.gwt.user.client.ui.Widget newComponent)
Description copied from interface: Container
Replace child of this layout with another component. Each layout must be able to switch children. To to this, one must just give references to a current and new child.

Specified by:
replaceChildComponent in interface Container
Parameters:
oldComponent - Child to be replaced
newComponent - Child that replaces the oldComponent

updateCaption

public void updateCaption(Paintable component,
                          UIDL uidl)
Description copied from interface: Container
Update child components caption, description and error message.

Each component is responsible for maintaining its caption, description and error message. In most cases components doesn't want to do that and those elements reside outside of the component. Because of this layouts must provide service for it's childen to show those elements for them.

Specified by:
updateCaption in interface Container
Parameters:
component - Child component for which service is requested.
uidl - UIDL of the child component.

requestLayout

public boolean requestLayout(Set<Paintable> child)
Description copied from interface: Container
Called when a child components size has been updated in the rendering phase.

Specified by:
requestLayout in interface Container
Parameters:
child - Set of child widgets whose size have changed
Returns:
true if the size of the Container remains the same, false if the event need to be propagated to the Containers parent

getAllocatedSpace

public RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)
Description copied from interface: Container
Returns the size currently allocated for the child component.

Specified by:
getAllocatedSpace in interface Container
Returns:

getTabCount

protected int getTabCount()
Implement in extending classes. This method should return the number of tabs currently rendered.

removeTab

protected void removeTab(int index)
Implement in extending classes. This method should remove the rendered tab with the specified index.

getTab

protected Paintable getTab(int index)
Implement in extending classes. This method should return the Paintable corresponding to the given index.

Copyright © 2000-2011 Vaadin Ltd. All Rights Reserved.