|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.portlet.WindowState
public class 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 | |
---|---|
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. |
Constructor Summary | |
---|---|
WindowState(java.lang.String name)
Creates a new window state with the given name. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final WindowState NORMAL
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"
.
public static final WindowState MAXIMIZED
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"
.
public static final WindowState MINIMIZED
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 |
---|
public WindowState(java.lang.String name)
Upper case letters in the name are converted to lower case letters.
name
- The name of the window stateMethod Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object object)
true
if the
Strings equals
method for the String
representing the two window states returns true
.
equals
in class java.lang.Object
object
- the window state to compare this window state with.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |