Package com.vaadin.ui

Class LegacyWindow

    • Constructor Detail

      • LegacyWindow

        public LegacyWindow()
        Deprecated.
        Create a new legacy window

      • LegacyWindow

        public LegacyWindow​(String caption)
        Deprecated.
        Creates a new legacy window with the given caption
        Parameters:
        caption - the caption of the window

      • LegacyWindow

        public 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​(VaadinRequest request)
        Deprecated.
        Description copied from class: UI
        Initializes this UI. 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 UI is not properly set up when the constructor is invoked.

        The VaadinRequest can be used to get information about the request that caused this UI to be created.

        Specified by:
        init in class UI
        Parameters:
        request - the Vaadin request that caused this UI to be created

      • setApplication

        public void setApplication​(LegacyApplication application)
        Deprecated.

      • 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 LegacyApplication.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 LegacyApplication.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().setLocation instead
        Opens the given resource in this UI. The contents of this UI is replaced by the Resource.
        Parameters:
        resource - the resource to show in this UI

      • 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.

        As of Vaadin 7.0.0, the functionality for opening a Resource in a Page has been replaced with similar methods based on a String URL. This is because the usage of Resource is problematic with memory management and with security features in some browsers. Is is recommended to instead use Link for starting downloads.

        Parameters:
        resource - the resource.
        windowName - the name of the window.

      • open

        public void open​(Resource resource,
                 String windowName,
                 boolean tryToOpenAsPopup)
        Deprecated.
        Opens the given resource in a window with the given name and optionally tries to force the resource to open in a new window instead of a new tab.

        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.

        If windowName is set to open the resource in a new window or tab and tryToOpenAsPopup is true, this method attempts to force the browser to open a new window instead of a tab. NOTE: This is a best-effort attempt and may not work reliably with all browsers and different pop-up preferences. With most browsers using default settings, tryToOpenAsPopup works properly.

        As of Vaadin 7.0.0, the functionality for opening a Resource in a Page has been replaced with similar methods based on a String URL. This is because the usage of Resource is problematic with memory management and with security features in some browsers. Is is recommended to instead use Link for starting downloads.

        Parameters:
        resource - the resource.
        windowName - the name of the window.
        tryToOpenAsPopup - Whether to try to force the resource to be opened in a new window

      • open

        @Deprecated
public void open​(Resource resource,
                 String windowName,
                 int width,
                 int height,
                 BorderStyle 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).

        As of Vaadin 7.0.0, the functionality for opening a Resource in a Page has been replaced with similar methods based on a String URL. This is because the usage of Resource is problematic with memory management and with security features in some browsers. Is is recommended to instead use Link for starting downloads.

        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.

      • 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 UI 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 UI 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: UI
        Setting the caption of a UI is not supported. To set the title of the HTML page, use Page.setTitle
        Specified by:
        setCaption in interface Component
        Overrides:
        setCaption in class UI
        Parameters:
        caption - the new caption String for the component.

      • replaceComponent

        public void replaceComponent​(Component oldComponent,
                             Component newComponent)
        Deprecated.
        This implementation replaces a component in the content container ( getContent()) instead of in the actual UI. This method should only be called when the content is a ComponentContainer (default VerticalLayout or explicitly set).

      • addComponent

        public void addComponent​(Component component)
        Deprecated.
        Adds a component to this UI. The component is not added directly to the UI, but instead to the content container (getContent()). This method should only be called when the content is a ComponentContainer (default VerticalLayout or explicitly set).
        Parameters:
        component - the component to add to this UI
        See Also:
        getContent()

      • removeComponent

        public void removeComponent​(Component component)
        Deprecated.
        This implementation removes the component from the content container ( getContent()) instead of from the actual UI. This method should only be called when the content is a ComponentContainer (default VerticalLayout or explicitly set).

      • removeAllComponents

        public void removeAllComponents()
        Deprecated.
        This implementation removes the components from the content container ( getContent()) instead of from the actual UI. This method should only be called when the content is a ComponentContainer (default VerticalLayout or explicitly set).