com.vaadin.terminal.gwt.client.ui.root
Class VRoot

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.root.VRoot

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.ResizeHandler, com.google.gwt.event.shared.EventHandler, 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, com.google.gwt.user.client.Window.ClosingHandler, Focusable, ShortcutActionHandler.ShortcutActionHandlerOwner, Iterable<com.google.gwt.user.client.ui.Widget>

public class VRoot
extends com.google.gwt.user.client.ui.SimplePanel
implements com.google.gwt.event.logical.shared.ResizeHandler, com.google.gwt.user.client.Window.ClosingHandler, 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	BROWSER_HEIGHT_VAR
static String	BROWSER_WIDTH_VAR
static String	CLICK_EVENT_ID Identifies the click event
static String	FRAGMENT_VARIABLE
static String	NOTIFICATION_HTML_CONTENT_NOT_ALLOWED
static String	RESIZE_LAZY Attribute name for the lazy resize setting .

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

DEBUG_ID_PREFIX

Constructor Summary

VRoot()

Method Summary

void	focus() Sets focus to this widget.
ShortcutActionHandler	getShortcutActionHandler() Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler
String	getTheme()
static void	goTo(String url)
boolean	isEmbedded() Returns true if the body is NOT generated, i.e if someone else has made the page that we're running in.
protected boolean	isMonitoringParentSize() Returns true if the size of the parent should be checked periodically and the application should react to its changes.
protected void	onAttach()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	onDetach()
protected void	onLoad() Start to periodically monitor for parent element resizes if embedded application (e.g.
void	onResize(com.google.gwt.event.logical.shared.ResizeEvent event)
protected void	onUnload() Stop monitoring for parent element resizes.
void	onWindowClosing(com.google.gwt.user.client.Window.ClosingEvent event)
protected void	performSizeCheck() Called when the window or parent div might have been resized.
protected void	windowSizeMaybeChanged(int newWindowWidth, int newWindowHeight) Deprecated. use performSizeCheck()

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

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

FRAGMENT_VARIABLE

public static final String FRAGMENT_VARIABLE

See Also:

Constant Field Values

BROWSER_HEIGHT_VAR

public static final String BROWSER_HEIGHT_VAR

See Also:

Constant Field Values

BROWSER_WIDTH_VAR

public static final String BROWSER_WIDTH_VAR

See Also:

Constant Field Values

NOTIFICATION_HTML_CONTENT_NOT_ALLOWED

public static final String NOTIFICATION_HTML_CONTENT_NOT_ALLOWED

See Also:

Constant Field Values

CLICK_EVENT_ID

public static final String CLICK_EVENT_ID

Identifies the click event

See Also:

Constant Field Values

RESIZE_LAZY

public static final String RESIZE_LAZY

Attribute name for the lazy resize setting .

See Also:

Constant Field Values

Constructor Detail

VRoot

public VRoot()

Method Detail

onLoad

protected void onLoad()

Start to periodically monitor for parent element resizes if embedded application (e.g. portlet).

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

onAttach

protected void onAttach()

Overrides:

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

onDetach

protected void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

onUnload

protected void onUnload()

Stop monitoring for parent element resizes.

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

performSizeCheck

protected void performSizeCheck()

Called when the window or parent div might have been resized. This immediately checks the sizes of the window and the parent div (if monitoring it) and triggers layout recalculation if they have changed.

windowSizeMaybeChanged

@Deprecated
protected void windowSizeMaybeChanged(int newWindowWidth,
                                                 int newWindowHeight)

Deprecated. use performSizeCheck()

Called when the window or parent div might have been resized. This immediately checks the sizes of the window and the parent div (if monitoring it) and triggers layout recalculation if they have changed.

Parameters:

newWindowWidth - The new width of the window

newWindowHeight - The new height of the window

getTheme

public String getTheme()

isEmbedded

public boolean isEmbedded()

Returns true if the body is NOT generated, i.e if someone else has made the page that we're running in. Otherwise we're in charge of the whole page.

Returns:

true if we're running embedded

isMonitoringParentSize

protected boolean isMonitoringParentSize()

Returns true if the size of the parent should be checked periodically and the application should react to its changes.

Returns:

true if size of parent should be tracked

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

onResize

public void onResize(com.google.gwt.event.logical.shared.ResizeEvent event)

Specified by:

onResize in interface com.google.gwt.event.logical.shared.ResizeHandler

goTo

public static void goTo(String url)

onWindowClosing

public void onWindowClosing(com.google.gwt.user.client.Window.ClosingEvent event)

Specified by:

onWindowClosing in interface com.google.gwt.user.client.Window.ClosingHandler

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

focus

public void focus()

Description copied from interface: Focusable

Sets focus to this widget.

Specified by:

focus in interface Focusable