|
Portlet API 2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The PortletWindow
represents the window that encloses
a portlet. The portlet window can send events on manipulation of its
various window controls, like the "minimize" or "close" buttons.
But a portlet also interrogate the portlet window about its current
visibility state. For example, a portlet may render its content
differently depending on whether its window is maximized or not.
Method Summary | |
void |
addWindowListener(WindowListener listener)
Adds the given listener to receive window events from this portlet window. |
boolean |
isClosed()
Returns whether this portlet window is currently closed. |
boolean |
isDetached()
Returns whether this portlet window is currently detached. |
boolean |
isMaximized()
Returns whether this portlet window is currently maximized. |
boolean |
isMinimized()
Returns whether this portlet window is currently minimized. |
void |
removeWindowListener(WindowListener listener)
Removes the given listener from receiving window events from this portlet window. |
void |
setClosed(boolean aFlag)
Sets this window to be closed. |
void |
setDetached(boolean aFlag)
Sets this window to be detached. |
void |
setMaximized(boolean aFlag)
Sets this window to be maximized. |
void |
setMinimized(boolean aFlag)
Sets this window to be minimized. |
void |
setTitle(PortletTitle title)
Sets the given title to be the title of this window. |
Method Detail |
public void addWindowListener(WindowListener listener)
If the given listener is null
, this method does
nothing.
listener
- the listener to be addedpublic void removeWindowListener(WindowListener listener)
If the given listener is null
, this method does
nothing.
listener
- the listener to be removedpublic void setTitle(PortletTitle title)
title
- the portlet titlepublic boolean isDetached()
true
if this window is detached, false
otherwisepublic boolean isMaximized()
true
if this window is maximized, false
otherwisepublic boolean isMinimized()
true
if this window is minimized, false
otherwisepublic boolean isClosed()
true
if this window is closed, false
otherwisepublic void setDetached(boolean aFlag)
aFlag
- a flag whether or not to detach this windowpublic void setMinimized(boolean aFlag)
aFlag
- a flag whether or not to minimize this windowpublic void setMaximized(boolean aFlag)
aFlag
- a flag whether or not to maximize this windowpublic void setClosed(boolean aFlag)
true
if this window is closed, false
otherwise
|
Portlet API 2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |