com.sun.portal.providers.containers.jsp.single
Class JSPSingleContainerProvider

java.lang.Object
  extended bycom.sun.portal.providers.ProviderAdapter
      extended bycom.sun.portal.providers.ProfileProviderAdapter
          extended bycom.sun.portal.providers.jsp.JSPProvider
              extended bycom.sun.portal.providers.containers.JSPContainerProviderAdapter
                  extended bycom.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider
All Implemented Interfaces:
ContainerProvider, Provider, ProviderEditTypes, ProviderWidths

public class JSPSingleContainerProvider
extends JSPContainerProviderAdapter

This class provides the implementation for JSPSingleContainerProvider and extends JSPContainerProviderAdapter Single Container simply displays a single leaf channel or a container. It can just be a JSP Page that wraps a container/leaf channel.

See Also:
JSPContainerProviderAdapter

Field Summary
 
Fields inherited from interface com.sun.portal.providers.ProviderWidths
WIDTH_FULL_BOTTOM, WIDTH_FULL_TOP, WIDTH_THICK, WIDTH_THIN
 
Fields inherited from interface com.sun.portal.providers.ProviderEditTypes
EDIT_COMPLETE, EDIT_SUBSET
 
Constructor Summary
JSPSingleContainerProvider()
           
 
Method Summary
 java.lang.String getSelectedChannel()
          Gets the selected channel name.
 java.lang.String getSelectedChannel(javax.servlet.http.HttpServletRequest req)
          Gets the selected channel name.
 int[] getSupportedWindowStates()
          Gets the supported window states.
 int getWindowState(java.lang.String channelName)
          Gets the window state of the channel.
 void setWindowState(java.lang.String channelName, int windowState)
          Sets the window state of a channel.
 
Methods inherited from class com.sun.portal.providers.containers.JSPContainerProviderAdapter
getAvailableAndUserDefinedChannels, getAvailableChannels, getContainerProviderContext, getRefreshTime, getSelectedChannels, setAvailableChannels, setSelectedChannels
 
Methods inherited from class com.sun.portal.providers.jsp.JSPProvider
getContent, getContentPage, getEdit, getEditPage, getExistingJSPPath, getMostSpecificJSPPath, getProcessPage, includeJspPage, init, isPresentable, processEdit
 
Methods inherited from class com.sun.portal.providers.ProfileProviderAdapter
existsBooleanProperty, existsIntegerProperty, existsListProperty, existsListProperty, existsStringProperty, existsStringProperty, getBooleanProperty, getBooleanProperty, getBooleanProperty, getBooleanProperty, getClientProperty, getIntegerProperty, getIntegerProperty, getIntegerProperty, getIntegerProperty, getListProperty, getListProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getStringAttribute, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getTemplate, getTemplate, getTemplatePath, isAllowed, setBooleanProperty, setClientProperty, setIntegerProperty, setListProperty, setMapProperty, setStringAttribute, setStringProperty
 
Methods inherited from class com.sun.portal.providers.ProviderAdapter
getContent, getDescription, getEdit, getEditType, getHelp, getHelp, getName, getProviderContext, getResourceBundle, getResourceBundle, getTitle, getWidth, isEditable, isPresentable, processEdit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JSPSingleContainerProvider

public JSPSingleContainerProvider()
Method Detail

getSelectedChannel

public java.lang.String getSelectedChannel()
                                    throws ProviderException
Gets the selected channel name.

Returns:
the selected channel name String.
Throws:
ProviderException - if more than one selected channel is defined.

getSelectedChannel

public java.lang.String getSelectedChannel(javax.servlet.http.HttpServletRequest req)
                                    throws ProviderException
Gets the selected channel name. This method gets the selected channel name by querying the request for parameter .selectedChannel and stores the selectedChannel name in session for future requests. If selectedChannel cannot be obtained either from the request or from session, then selectedChannel from a call to getSelectedChannel() is returned.

Returns:
the selected channel name String.
Throws:
ProviderException - if more than one selected channel is defined.
See Also:
getSelectedChannel()

getWindowState

public int getWindowState(java.lang.String channelName)
                   throws ProviderException
Gets the window state of the channel. This method just returns ProviderWindowStates.NORMAL.

Specified by:
getWindowState in interface ContainerProvider
Overrides:
getWindowState in class JSPContainerProviderAdapter
Parameters:
channelName - channel for which the window state is requested.
Returns:
window state
Throws:
ProviderException
See Also:
ProviderWindowStates.NORMAL

setWindowState

public void setWindowState(java.lang.String channelName,
                           int windowState)
                    throws UnsupportedWindowStateException
Sets the window state of a channel. This method currently has no effect and throws UnsupportedWindowStateException if windowState passed is not ProviderWindowStates#NORMAL. Subclasses that wish to allow setting a WindowState should override this method.

Specified by:
setWindowState in interface ContainerProvider
Overrides:
setWindowState in class JSPContainerProviderAdapter
Parameters:
channelName - channel for which the window state needs to be set
windowState - The new window state
Throws:
UnsupportedWindowStateException.
UnsupportedWindowStateException

getSupportedWindowStates

public int[] getSupportedWindowStates()
                               throws ProviderException
Gets the supported window states.

Specified by:
getSupportedWindowStates in interface ContainerProvider
Overrides:
getSupportedWindowStates in class JSPContainerProviderAdapter
Returns:
Supported Window States as an integer array containing ProviderWindowStates.NORMAL
Throws:
ProviderException - If the window states cannot be returned.
See Also:
ProviderWindowStates.NORMAL, com.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider#getWindowState(), com.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider#setWindowState()