Package javax.portlet
Class WindowState
java.lang.Object
javax.portlet.WindowState
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
FieldsModifier and TypeFieldDescriptionprivate String
static final WindowState
TheMAXIMIZED
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
When a portlet is inMINIMIZED
window state, the portlet should only render minimal output or no output at all.static final WindowState
TheNORMAL
window state indicates that a portlet may be sharing the page with other portlets. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
NORMAL
TheNORMAL
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
TheMAXIMIZED
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 isMAXIMIZED
.The string value for this state is
"maximized"
. -
MINIMIZED
When a portlet is inMINIMIZED
window state, the portlet should only render minimal output or no output at all.The string value for this state is
"minimized"
. -
_name
-
-
Constructor Details
-
WindowState
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
-
toString
Returns a String representation of this window state. Window state names are always lower case names. -
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. -
equals
Compares the specified object with this window state for equality. Returnstrue
if the Stringsequals
method for the String representing the two window states returnstrue
.
-