com.sun.portal.wireless.providers.containers.jsp
Class WirelessJSPContainerProviderAdapter

java.lang.Object
  extended byJSPContainerProviderAdapter
      extended bycom.sun.portal.wireless.providers.containers.jsp.WirelessJSPContainerProviderAdapter
Direct Known Subclasses:
JSPNativeContainerProvider, JSPRenderingContainerProvider

public class WirelessJSPContainerProviderAdapter
extends JSPContainerProviderAdapter

The WirelessJSPContainerProviderAdapter class extends JSPContainerProviderAdapter to provide methods specific for the wireless desktop for obtaining and manipulating row and channel data.

See Also:
Serialized Form

Constructor Summary
WirelessJSPContainerProviderAdapter()
           
 
Method Summary
 void downRow(HttpServletRequest httpReq, java.lang.String channel)
          Decreases the row in which this channel should be displayed.
 java.util.List getAvailableChannels(HttpServletRequest req)
          Gets a list of existing, presentable, available, and removable channels names (including any user-defined channels).
 java.util.List getAvailableChannels(HttpServletRequest req, boolean onlyRemovable)
          Gets a list of existing, presentable, and available channel names (including any user-defined channels).
 java.lang.String getMaximizedChannel(HttpServletRequest request)
          Gets the maximized channel specified by this request, or null if none exists, or the channel is not presentable.
 java.util.List getOrderedSelectedChannels(HttpServletRequest req)
          Gets an ordered list of existing, presentable, selected and movable channel names.
 java.util.List getOrderedSelectedChannels(HttpServletRequest req, boolean onlyMovable)
          Gets an ordered list of existing, presentable, and selected channel names.
 java.lang.String getRow(HttpServletRequest httpReq, java.lang.String channel)
          Gets the row in which this channel should be displayed.
 java.util.List getUserDefinedChannels()
          Gets the user-defined channels, or an empty list if none exist.
 int getWindowState(java.lang.String channelName)
          Gets the window state for the specified channel.
 boolean hasMaximizedChannel(HttpServletRequest request)
          Determines whether or not there is a maximized channel.
 void processContentChannelSelection(HttpServletRequest request)
          Processes submission from JSP desktop content selection page
 void upRow(HttpServletRequest httpReq, java.lang.String channel)
          Increases the row in which this channel should be displayed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WirelessJSPContainerProviderAdapter

public WirelessJSPContainerProviderAdapter()
Method Detail

getRow

public java.lang.String getRow(HttpServletRequest httpReq,
                               java.lang.String channel)
                        throws ProviderException
Gets the row in which this channel should be displayed.

Parameters:
httpReq - The servlet request
channel - the channel for which the row is requested
Returns:
The row for this channel; either "1", "2", ....
Throws:
ProviderException

upRow

public void upRow(HttpServletRequest httpReq,
                  java.lang.String channel)
           throws ProviderException
Increases the row in which this channel should be displayed.

Parameters:
httpReq - The servlet request
channel - The channel for which the row is requested
Throws:
ProviderException

downRow

public void downRow(HttpServletRequest httpReq,
                    java.lang.String channel)
             throws ProviderException
Decreases the row in which this channel should be displayed.

Parameters:
httpReq - The servlet request
channel - The channel for which the row is requested
Throws:
ProviderException

getUserDefinedChannels

public java.util.List getUserDefinedChannels()
                                      throws ProviderException
Gets the user-defined channels, or an empty list if none exist.

Returns:
List of user-defined channels
Throws:
ProviderException

getAvailableChannels

public java.util.List getAvailableChannels(HttpServletRequest req,
                                           boolean onlyRemovable)
                                    throws ProviderException
Gets a list of existing, presentable, and available channel names (including any user-defined channels).

Parameters:
req - the HttpServletRequest
onlyRemovable - true includes only removable channels
Returns:
the list of channel names
Throws:
ProviderException - if the channel names could not be obtained

getAvailableChannels

public java.util.List getAvailableChannels(HttpServletRequest req)
                                    throws ProviderException
Gets a list of existing, presentable, available, and removable channels names (including any user-defined channels).

Parameters:
req - the HttpServletRequest
Returns:
the list of channel names
Throws:
ProviderException - if the channel names could not be obtained

getOrderedSelectedChannels

public java.util.List getOrderedSelectedChannels(HttpServletRequest req,
                                                 boolean onlyMovable)
                                          throws ProviderException
Gets an ordered list of existing, presentable, and selected channel names.

Parameters:
req - the HttpServletRequest
onlyMovable - true includes only movable channels
Returns:
list of channel names
Throws:
ProviderException - if the channel names could not be obtained

getOrderedSelectedChannels

public java.util.List getOrderedSelectedChannels(HttpServletRequest req)
                                          throws ProviderException
Gets an ordered list of existing, presentable, selected and movable channel names.

Returns:
list of channel names
Throws:
ProviderException - if the channel names could not be obtained

getMaximizedChannel

public java.lang.String getMaximizedChannel(HttpServletRequest request)
                                     throws ProviderException
Gets the maximized channel specified by this request, or null if none exists, or the channel is not presentable.

Parameters:
request - the current request
Returns:
the maximized channel
Throws:
ProviderException - if the channel could not be obtained

getWindowState

public int getWindowState(java.lang.String channelName)
                   throws ProviderException
Gets the window state for the specified channel.

Parameters:
channelName - Name of the channel whose state is sought
Returns:
ProviderWindowStates.MINIMIZE if channel state is minimized, otherwise returns ProviderWindowStates.NORMAL
Throws:
ProviderException - if the state could not be obtained

hasMaximizedChannel

public boolean hasMaximizedChannel(HttpServletRequest request)
                            throws ProviderException
Determines whether or not there is a maximized channel.

Returns:
true if there is a maximized channel
Throws:
ProviderException - if the determination could not be made

processContentChannelSelection

public void processContentChannelSelection(HttpServletRequest request)
                                    throws ProviderException
Processes submission from JSP desktop content selection page

Parameters:
request - HttpServletRequest
Throws:
ProviderException - if the submission could not be processed