Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.portlet
Interface PortletWindow

public interface PortletWindow

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 can 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.

Since:

4.1

Nested Class Summary
static class	PortletWindow.State The State class is a finite enumeration of the possible states that a window can assume.

Method Summary
PortletWindow.State	getWindowState() Returns the current window state of this portlet
boolean	isDetached() Deprecated. use getWindowState() since version 1.1
boolean	isMaximized() Deprecated. use getWindowState() since version 1.1
boolean	isMinimized() Deprecated. use getWindowState() since version 1.1
void	setWindowState(PortletWindow.State state) Defines which portlet window state is shown next.

Method Detail

isDetached

public boolean isDetached()

Deprecated. use getWindowState() since version 1.1

Returns whether this portlet window is currently detached.

Returns:

true if this window is detached,
false otherwise

isMaximized

public boolean isMaximized()

Deprecated. use getWindowState() since version 1.1

Returns whether this portlet window is currently maximized.

Returns:

true if this window is maximized,
false otherwise

isMinimized

public boolean isMinimized()

Deprecated. use getWindowState() since version 1.1

Returns whether this portlet window is currently minimized.

Returns:

true if this window is minimized,
false otherwise

getWindowState

public PortletWindow.State getWindowState()

Returns the current window state of this portlet

Returns:

the window state

setWindowState

public void setWindowState(PortletWindow.State state)
                    throws AccessDeniedException

Defines which portlet window state is shown next.

This function may only be used during event processing, in any other case the call has no effect.

Parameters:

state - the portlet window state to be shown next

Throws:

AccessDeniedException - if the portlet tries to access this function outside of the event processing