Package javax.portlet
Class WindowState
- java.lang.Object
-
- javax.portlet.WindowState
-
public class WindowState extends java.lang.Object
TheWindowState
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 private java.lang.String
_name
static WindowState
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.static WindowState
MINIMIZED
When a portlet is inMINIMIZED
window state, the portlet should only render minimal output or no output at all.static WindowState
NORMAL
TheNORMAL
window state indicates that a portlet may be sharing the page with other portlets.
-
Constructor Summary
Constructors Constructor Description WindowState(java.lang.String name)
Creates a new window state with the given name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object object)
Compares the specified object with this window state for equality.int
hashCode()
Returns the hash code value for this window state.java.lang.String
toString()
Returns a String representation of this window state.
-
-
-
Field Detail
-
NORMAL
public static final WindowState 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
public static final WindowState 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
public static final WindowState 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
private java.lang.String _name
-
-
Method Detail
-
toString
public java.lang.String toString()
Returns a String representation of this window state. Window state names are always lower case names.- Overrides:
toString
in classjava.lang.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 classjava.lang.Object
- Returns:
- hash code value for this window state
-
equals
public boolean equals(java.lang.Object object)
Compares the specified object with this window state for equality. Returnstrue
if the Stringsequals
method for the String representing the two window states returnstrue
.- Overrides:
equals
in classjava.lang.Object
- Parameters:
object
- the window state to compare this window state with.- Returns:
- true, if the specified object is equal with this window state.
-
-