com.vaadin.ui
Class Root.LegacyWindow

java.lang.Object
  com.vaadin.terminal.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractComponentContainer
              com.vaadin.ui.Root
                  com.vaadin.ui.Root.LegacyWindow

All Implemented Interfaces:

Action.Container, Action.Notifier, MethodEventSource, Connector, ClientConnector, RpcTarget, Sizeable, Vaadin6Component, VariableOwner, Component, ComponentContainer, HasComponents, Serializable, Iterable<Component>, EventListener

Enclosing class:

Root

Deprecated.

@Deprecated
public static class Root.LegacyWindow
extends Root

Helper class to emulate the main window from Vaadin 6 using roots. This class should be used in the same way as Window used as a browser level window in Vaadin 6 with Application.LegacyApplication

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.Root

Root.LegacyWindow

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner

VariableOwner.ErrorEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable

Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Field Summary

Fields inherited from class com.vaadin.ui.Root

actionManager

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Root.LegacyWindow()
Deprecated. Create a new legacy window

Root.LegacyWindow(String caption)
Deprecated. Creates a new legacy window with the given caption

Root.LegacyWindow(String caption, ComponentContainer content)
Deprecated. Creates a legacy window with the given caption and content layout

Method Summary

void	addListener(Page.BrowserWindowResizeListener resizeListener) Deprecated. As of 7.0, use the similarly named api in Page instead
void	executeJavaScript(String script) Deprecated. as of 7.0, use JavaScript.getCurrent().execute(String) instead
int	getBrowserWindowHeight() Deprecated. As of 7.0, use the similarly named api in Page instead
int	getBrowserWindowWidth() Deprecated. As of 7.0, use the similarly named api in Page instead
String	getName() Deprecated. Gets the unique name of the window.
URL	getURL() Deprecated. Gets the full URL of the window.
protected void	init(WrappedRequest request) Deprecated. Initializes this root.
void	open(Resource resource) Deprecated. As of 7.0, use getPage().open instead
void	open(Resource resource, String windowName) Deprecated. As of 7.0, use getPage().open instead
void	open(Resource resource, String windowName, int width, int height, int border) Deprecated. As of 7.0, use getPage().open instead
void	removeListener(Page.BrowserWindowResizeListener resizeListener) Deprecated. As of 7.0, use the similarly named api in Page instead
void	setCaption(String caption) Deprecated. Setting the caption of a Root is not supported.
void	setName(String name) Deprecated. Sets the unique name of the window.

Methods inherited from class com.vaadin.ui.Root

addAction, addActionHandler, addComponent, addListener, addWindow, changeVariables, doInit, focus, getActionManager, getApplication, getComponentCount, getComponentIterator, getConnectorTracker, getContent, getCurrent, getPage, getRoot, getRootId, getState, getStateType, getWindows, isConnectorEnabled, isResizeLazy, paintContent, removeAction, removeActionHandler, removeAllComponents, removeComponent, removeListener, removeWindow, replaceComponent, scrollIntoView, setApplication, setContent, setCurrent, setFocusedComponent, setResizeLazy, setRootId, setScrollTop, showNotification, showNotification, showNotification, showNotification, showNotification, showNotification

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, isComponentVisible, iterator, moveComponentsFrom, removeListener, removeListener, setHeight, setVisible, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, requestRepaint, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setWidth, updateState

Methods inherited from class com.vaadin.terminal.AbstractClientConnector

addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.terminal.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDebugId, getIcon, getLocale, getParent, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState

Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector

detach, getExtensions, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.terminal.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth

Constructor Detail

Root.LegacyWindow

public Root.LegacyWindow()

Deprecated.

Create a new legacy window

Root.LegacyWindow

public Root.LegacyWindow(String caption)

Deprecated.

Creates a new legacy window with the given caption

Parameters:

caption - the caption of the window

Root.LegacyWindow

public Root.LegacyWindow(String caption,
                         ComponentContainer content)

Deprecated.

Creates a legacy window with the given caption and content layout

Parameters:

caption -

content -

Method Detail

init

protected void init(WrappedRequest request)

Deprecated.

Description copied from class: Root

Initializes this root. This method is intended to be overridden by subclasses to build the view and configure non-component functionality. Performing the initialization in a constructor is not suggested as the state of the root is not properly set up when the constructor is invoked.

The WrappedRequest can be used to get information about the request that caused this root to be created. By default, the WrappedRequest.BrowserDetails will be available in the request. If the browser details are not required, loading the application in the browser can take some shortcuts giving a faster initial rendering. This can be indicated by adding the EagerInit annotation to the Root class.

Specified by:

init in class Root

Parameters:

request - the wrapped request that caused this root to be created

getName

public String getName()

Deprecated.

Gets the unique name of the window. The name of the window is used to uniquely identify it.

The name also determines the URL that can be used for direct access to a window. All windows can be accessed through http://host:port/app/win where http://host:port/app is the application URL (as returned by Application.getURL() and win is the window name.

Note! Portlets do not support direct window access through URLs.

Returns:

the Name of the Window.

setName

public void setName(String name)

Deprecated.

Sets the unique name of the window. The name of the window is used to uniquely identify it inside the application.

The name also determines the URL that can be used for direct access to a window. All windows can be accessed through http://host:port/app/win where http://host:port/app is the application URL (as returned by Application.getURL() and win is the window name.

This method can only be called before the window is added to an application.

Note! Portlets do not support direct window access through URLs.

Parameters:

name - the new name for the window or null if the application should automatically assign a name to it

Throws:

IllegalStateException - if the window is attached to an application

getURL

public URL getURL()

Deprecated.

Gets the full URL of the window. The returned URL is window specific and can be used to directly refer to the window.

Note! This method can not be used for portlets.

Returns:

the URL of the window or null if the window is not attached to an application

open

@Deprecated
public void open(Resource resource)

Deprecated. As of 7.0, use getPage().open instead

Opens the given resource in this root. The contents of this Root is replaced by the Resource.

Parameters:

resource - the resource to show in this root

open

@Deprecated
public void open(Resource resource,
                            String windowName)

Deprecated. As of 7.0, use getPage().open instead

Opens the given resource in a window with the given name.

The supplied windowName is used as the target name in a window.open call in the client. This means that special values such as "_blank", "_self", "_top", "_parent" have special meaning. An empty or null window name is also a special case.

"", null and "_self" as windowName all causes the resource to be opened in the current window, replacing any old contents. For downloadable content you should avoid "_self" as "_self" causes the client to skip rendering of any other changes as it considers them irrelevant (the page will be replaced by the resource). This can speed up the opening of a resource, but it might also put the client side into an inconsistent state if the window content is not completely replaced e.g., if the resource is downloaded instead of displayed in the browser.

"_blank" as windowName causes the resource to always be opened in a new window or tab (depends on the browser and browser settings).

"_top" and "_parent" as windowName works as specified by the HTML standard.

Any other windowName will open the resource in a window with that name, either by opening a new window/tab in the browser or by replacing the contents of an existing window with that name.

Parameters:

resource - the resource.

windowName - the name of the window.

open

@Deprecated
public void open(Resource resource,
                            String windowName,
                            int width,
                            int height,
                            int border)

Deprecated. As of 7.0, use getPage().open instead

Opens the given resource in a window with the given size, border and name. For more information on the meaning of windowName, see open(Resource, String).

Parameters:

resource - the resource.

windowName - the name of the window.

width - the width of the window in pixels

height - the height of the window in pixels

border - the border style of the window. See Window.BORDER_* constants

addListener

@Deprecated
public void addListener(Page.BrowserWindowResizeListener resizeListener)

Deprecated. As of 7.0, use the similarly named api in Page instead

Adds a new Page.BrowserWindowResizeListener to this root. The listener will be notified whenever the browser window within which this root resides is resized.

Parameters:

resizeListener - the listener to add

See Also:

BrowserWindowResizeListener#browserWindowResized(BrowserWindowResizeEvent), Root.setResizeLazy(boolean)

removeListener

@Deprecated
public void removeListener(Page.BrowserWindowResizeListener resizeListener)

Deprecated. As of 7.0, use the similarly named api in Page instead

Removes a Page.BrowserWindowResizeListener from this root. The listener will no longer be notified when the browser window is resized.

Parameters:

resizeListener - the listener to remove

getBrowserWindowHeight

@Deprecated
public int getBrowserWindowHeight()

Deprecated. As of 7.0, use the similarly named api in Page instead

Gets the last known height of the browser window in which this root resides.

Returns:

the browser window height in pixels

getBrowserWindowWidth

@Deprecated
public int getBrowserWindowWidth()

Deprecated. As of 7.0, use the similarly named api in Page instead

Gets the last known width of the browser window in which this root resides.

Returns:

the browser window width in pixels

executeJavaScript

@Deprecated
public void executeJavaScript(String script)

Deprecated. as of 7.0, use JavaScript.getCurrent().execute(String) instead

Executes JavaScript in this window.

This method allows one to inject javascript from the server to client. A client implementation is not required to implement this functionality, but currently all web-based clients do implement this.

Executing javascript this way often leads to cross-browser compatibility issues and regressions that are hard to resolve. Use of this method should be avoided and instead it is recommended to create new widgets with GWT. For more info on creating own, reusable client-side widgets in Java, read the corresponding chapter in Book of Vaadin.

Parameters:

script - JavaScript snippet that will be executed.

setCaption

public void setCaption(String caption)

Deprecated.

Description copied from class: Root

Setting the caption of a Root is not supported. To set the title of the HTML page, use Page.setTitle

Specified by:

setCaption in interface Component

Overrides:

setCaption in class Root

Parameters:

caption - the new caption String for the component.