Package jakarta.portlet

Class WindowState

  • public class WindowState
extends Object
    The WindowState class represents the possible window states that a portlet window can assume.

    This class defines a standard set of the most basic portlet window states. Additional window states may be defined by calling the constructor of this class. If a portal/portlet-container does not support a custom window state defined in the portlet application deployment descriptor, the custom window state will be ignored by the portal/portlet container.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static WindowState MAXIMIZED
      The MAXIMIZED window state is an indication that a portlet may be the only portlet being rendered in the portal page, or that the portlet has more space compared to other portlets in the portal page.
      static WindowState MINIMIZED
      When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.
      static WindowState NORMAL
      The NORMAL window state indicates that a portlet may be sharing the page with other portlets.
      static WindowState UNDEFINED
      The window state UNDEFINED is returned by the getWindowState method when the window state is not available.

    • Constructor Summary

      Constructors 
      Constructor Description
      WindowState()
      No-arg constructor to make object proxyable
      WindowState​(String name)
      Creates a new window state with the given name.

    • Field Detail

      • UNDEFINED

        public static final WindowState UNDEFINED
        The window state UNDEFINED is returned by the getWindowState method when the window state is not available.

        This mode may not be used to set the window state in the setWindowState method.

        The string value for this mode is "undefined".

        Since:
        3.0

      • NORMAL

        public static final WindowState NORMAL
        The NORMAL window state indicates that a portlet may be sharing the page with other portlets. It may also indicate that the target device has limited display capabilities. Therefore, a portlet should restrict the size of its rendered output in this window state.

        The string value for this state is "normal".

      • MAXIMIZED

        public static final WindowState MAXIMIZED
        The MAXIMIZED window state is an indication that a portlet may be the only portlet being rendered in the portal page, or that the portlet has more space compared to other portlets in the portal page. A portlet may generate richer content when its window state is MAXIMIZED.

        The string value for this state is "maximized".

      • MINIMIZED

        public static final WindowState MINIMIZED
        When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.

        The string value for this state is "minimized".

    • Constructor Detail

      • WindowState

        public WindowState()
        No-arg constructor to make object proxyable
        Since:
        3.0

      • WindowState

        public WindowState​(String name)
        Creates a new window state with the given name.

        Upper case letters in the name are converted to lower case letters.

        Parameters:
        name - The name of the window state

    • Method Detail

      • toString

        public String toString()
        Returns a String representation of this window state. Window state names are always lower case names.
        Overrides:
        toString in class Object
        Returns:
        String representation of this window state.

      • hashCode

        public int hashCode()
        Returns the hash code value for this window state. The hash code is constructed by producing the hash value of the String value of this window state.
        Overrides:
        hashCode in class Object
        Returns:
        hash code value for this window state

      • equals

        public boolean equals​(Object object)
        Compares the specified object with this window state for equality. Returns true if the Strings equals method for the String representing the two window states returns true.
        Overrides:
        equals in class Object
        Parameters:
        object - the window state to compare this window state with.
        Returns:
        true, if the specified object is equal with this window state.