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


Class VPanel

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.SimplePanel
                  com.vaadin.terminal.gwt.client.ui.VPanel

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.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Container, Focusable, Paintable, ShortcutActionHandler.ShortcutActionHandlerOwner, Iterable<com.google.gwt.user.client.ui.Widget>

public class VPanel
extends com.google.gwt.user.client.ui.SimplePanel
implements Container, ShortcutActionHandler.ShortcutActionHandlerOwner, Focusable

Nested Class Summary
 
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.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
 
Field Summary
static String CLASSNAME
           
static String CLICK_EVENT_IDENTIFIER
           
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
VPanel()
           
 
Method Summary
 void focus()
          Sets focus to this widget.
 RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)
          Returns the size currently allocated for the child component.
protected  com.google.gwt.user.client.Element getContainerElement()
           
 ShortcutActionHandler getShortcutActionHandler()
          Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler
 boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)
          Is a given component child of this layout.
protected  void onAttach()
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
           
 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.
 void runHacks(boolean runGeckoFix)
           
 void setFocus(boolean focus)
          Sets the keyboard focus on the Panel
 void setHeight(String height)
           
 void setStyleName(String style)
           
 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.SimplePanel
add, getWidget, iterator, remove, setWidget, setWidget
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
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, 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, 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
 
Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets
add, clear, iterator, remove
 

Field Detail

CLICK_EVENT_IDENTIFIER

public static final String CLICK_EVENT_IDENTIFIER

See Also:

Constant Field Values

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

Constructor Detail

VPanel

public VPanel()
Method Detail

setFocus

public void setFocus(boolean focus)

Sets the keyboard focus on the Panel

Parameters:
focus - Should the panel have focus or not.

focus

public void focus()

Description copied from interface: Focusable

Sets focus to this widget.

Specified by:
focus in interface Focusable

getContainerElement

protected com.google.gwt.user.client.Element getContainerElement()

Overrides:
getContainerElement in class com.google.gwt.user.client.ui.SimplePanel

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:
updateFromUIDL in interface Paintable

setStyleName

public void setStyleName(String style)

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

runHacks

public void runHacks(boolean runGeckoFix)

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class com.google.gwt.user.client.ui.Widget

setHeight

public void setHeight(String height)

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

setWidth

public void setWidth(String width)

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

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

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:

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

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.

onAttach

protected void onAttach()

Overrides:
onAttach in class com.google.gwt.user.client.ui.Widget

getShortcutActionHandler

public ShortcutActionHandler getShortcutActionHandler()

Description copied from interface: ShortcutActionHandler.ShortcutActionHandlerOwner

Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler

Specified by:
getShortcutActionHandler in interface ShortcutActionHandler.ShortcutActionHandlerOwner