Top Description Fields Constructors Methods
javax.portlet

public Class WindowState

extends Object
Class Inheritance
Imports
java.util.Locale
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

Modifier and TypeField and Description
private String
_name

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.

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.

public static final WindowState
NORMAL

The NORMAL window state indicates that a portlet may be sharing the page with other portlets.

public static final WindowState
UNDEFINED

The window state UNDEFINED is returned by the getWindowState method when the window state is not available.

Constructor Summary

AccessConstructor and Description
public
WindowState()

No-arg constructor to make object proxyable
public
WindowState(String
The name of the window state
name)

Creates a new window state with the given name.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true, if the specified object is equal with this window state.
equals(Object
the window state to compare this window state with.
object)

Overrides java.lang.Object.equals.

Compares the specified object with this window state for equality.
public int

Returns:

hash code value for this window state
hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code value for this window state.
public String

Returns:

String representation of this window state.
toString()

Overrides java.lang.Object.toString.

Returns a String representation of this window state.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_nameback to summary
private String _name
MAXIMIZEDback to summary
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".

MINIMIZEDback to summary
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".

NORMALback to summary
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".

UNDEFINEDback to summary
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

Constructor Detail

WindowStateback to summary
public WindowState()

No-arg constructor to make object proxyable
Since
3.0
WindowStateback to summary
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:String

The name of the window state

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

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.

Parameters
object:Object

the window state to compare this window state with.

Returns:boolean

true, if the specified object is equal with this window state.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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.

Returns:int

hash code value for this window state

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a String representation of this window state. Window state names are always lower case names.

Returns:String

String representation of this window state.