com.vaadin.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.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.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Focusable, HasErrorIndicatorElement, ShortcutActionHandler.ShortcutActionHandlerOwner, Iterable<com.google.gwt.user.client.ui.Widget>

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

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

Fields

Modifier and Type	Field and Description
com.google.gwt.dom.client.Element	bottomDecoration For internal use only.
com.google.gwt.dom.client.Element	captionNode For internal use only.
static String	CLASSNAME
ApplicationConnection	client For internal use only.
com.google.gwt.dom.client.Element	contentNode For internal use only.
String	id For internal use only.
int	scrollLeft For internal use only.
int	scrollTop For internal use only.
ShortcutActionHandler	shortcutHandler For internal use only.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VPanel()

Method Summary

Modifier and Type	Method and Description
void	focus() Sets focus to this widget.
protected com.google.gwt.user.client.Element	getContainerElement()
com.google.gwt.dom.client.Element	getErrorIndicatorElement() Gets the error indicator element.
ShortcutActionHandler	getShortcutActionHandler() Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler.
void	makeScrollable() Ensures the panel is scrollable e.g.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	setCaption(String text, boolean captionAsHtml) For internal use only.
void	setErrorIndicatorElementVisible(boolean visible) Sets the visibility of the error indicator element.
void	setFocus(boolean focus) Sets the keyboard focus on the Panel.
void	setIconUri(String iconUri, ApplicationConnection client) For internal use only.

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, clear, 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, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

client

public ApplicationConnection client

For internal use only. May be removed or replaced in the future.

id

public String id

For internal use only. May be removed or replaced in the future.

captionNode

public final com.google.gwt.dom.client.Element captionNode

For internal use only. May be removed or replaced in the future.

bottomDecoration

public final com.google.gwt.dom.client.Element bottomDecoration

For internal use only. May be removed or replaced in the future.

contentNode

public final com.google.gwt.dom.client.Element contentNode

For internal use only. May be removed or replaced in the future.

shortcutHandler

public ShortcutActionHandler shortcutHandler

For internal use only. May be removed or replaced in the future.

scrollTop

public int scrollTop

For internal use only. May be removed or replaced in the future.

scrollLeft

public int scrollLeft

For internal use only. May be removed or replaced in the future.

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

setCaption

public void setCaption(String text,
                       boolean captionAsHtml)

For internal use only. May be removed or replaced in the future.

setIconUri

public void setIconUri(String iconUri,
                       ApplicationConnection client)

For internal use only. May be removed or replaced in the future.

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

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

makeScrollable

public void makeScrollable()

Ensures the panel is scrollable e.g. after style name changes.

For internal use only. May be removed or replaced in the future.

getErrorIndicatorElement

public com.google.gwt.dom.client.Element getErrorIndicatorElement()

Description copied from interface: HasErrorIndicatorElement

Gets the error indicator element.

Specified by:

getErrorIndicatorElement in interface HasErrorIndicatorElement

Returns:

the error indicator element

setErrorIndicatorElementVisible

public void setErrorIndicatorElementVisible(boolean visible)

Description copied from interface: HasErrorIndicatorElement

Sets the visibility of the error indicator element.

Specified by:

setErrorIndicatorElementVisible in interface HasErrorIndicatorElement

Parameters:

visible - true to show the error indicator element, false to hide it