|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ContainerProvider
defines the interface for
implementing a container provider.
A container provider is a provider that generates its views primarily
by being a client of other provider objects. Here, a container provider
is defined as a provider that has a selected and available channels list,
and allows getting and setting of these lists.
Selected channels are those that are visible on the portal page.
Available channels are those that are available to
be activated on the portal page.
A selected channels list should only contain channels that are visisble
when the containers displays its main view.
Provider
Method Summary | |
java.util.List |
getAvailableChannels()
Gets the list of available channel names. |
java.util.List |
getSelectedChannels()
Gets the list of selected channel names. |
int[] |
getSupportedWindowStates()
Gets the supported window states. |
int |
getWindowState(java.lang.String channelName)
Gets the window state of the channel. |
void |
setAvailableChannels(java.util.List avail)
Sets the list of available channel names. |
void |
setSelectedChannels(java.util.List sel)
Sets the list of selected channel names. |
void |
setWindowState(java.lang.String channelName,
int windowState)
Sets the window state of the channel. |
Method Detail |
public java.util.List getSelectedChannels() throws ProviderException
ProviderException
- If the list of channel names cannot be
returned.public java.util.List getAvailableChannels() throws ProviderException
ProviderException
- If the list of channel names cannot be
returned.public void setSelectedChannels(java.util.List sel) throws ProviderException
ProviderException
- If the list of channel names cannot be
set.public void setAvailableChannels(java.util.List avail) throws ProviderException
ProviderException
- If the list of channel names cannot be
set.public int getWindowState(java.lang.String channelName) throws ProviderException
channelName
- channel for which window state is requested.
ProviderException
- If the window state cannot be returned.com.sun.portal.providers.containers.ContainerProvider#setWindowState()
public void setWindowState(java.lang.String channelName, int windowState) throws UnsupportedWindowStateException
channelName
- channel for which window state needs to be setwindowState
- The new window state.
UnsupportedWindowStateException
- If the window state cannot be set or
if the window state passed in is not in supported window states.com.sun.portal.providers.containers.ContainerProvider#getWindowState()
,
getSupportedWindowStates()
public int[] getSupportedWindowStates() throws ProviderException
ProviderException
- If the window states cannot be returned.com.sun.portal.providers.containers.ContainerProvider#getWindowState()
,
com.sun.portal.providers.containers.ContainerProvider#setWindowState()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |