Package javax.portlet

Class WindowState

java.lang.Object
javax.portlet.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.
Version:
$Revision: 6047 $
Author:
Julien Viet

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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.
    static final WindowState
    MINIMIZED
    When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.
    static final WindowState
    NORMAL
    The NORMAL window state indicates that a portlet may be sharing the page with other portlets.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WindowState(String name)
    Creates a new window state with the given name.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Compares the specified object with this window state for equality.
    int
    hashCode()
    Returns the hash code value for this window state.
    String
    toString()
    Returns a String representation of this window state.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

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

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

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

  • Constructor Details

    • 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 portlet mode

  • Method Details

    • equals

      public boolean equals(Object o)
      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:
      o - the window state to compare this window state with.
      Returns:
      true, if the specified object is equal with 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

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