uPortal 2.4.1
API Documentation

org.jasig.portal.channels.UserPreferences
Class TabColumnPrefsState

java.lang.Object
  extended byorg.jasig.portal.channels.UserPreferences.BaseState
      extended byorg.jasig.portal.channels.UserPreferences.TabColumnPrefsState
All Implemented Interfaces:
IChannel, IPrivileged, IPrivilegedChannel

public class TabColumnPrefsState
extends org.jasig.portal.channels.UserPreferences.BaseState

This user preferences component is for use with layouts based on the tab-column structure.

Version:
$Revision: 1.71 $
Author:
Ken Weiner, kweiner@unicon.net

Constructor Summary
TabColumnPrefsState()
           
TabColumnPrefsState(CUserPreferences context)
           
 
Method Summary
 ChannelRuntimeProperties getRuntimeProperties()
          Acquires ChannelRuntimeProperites from the channel.
 void receiveEvent(PortalEvent ev)
          Passes an outside event to a channel.
 void renderXML(org.xml.sax.ContentHandler out)
          Ask channel to render its content.
 void setContext(CUserPreferences context)
           
 void setPortalControlStructures(PortalControlStructures pcs)
          Passes portal control structure to the channel.
 void setRuntimeData(ChannelRuntimeData rd)
          Passes ChannelRuntimeData to the channel.
 void setState(IPrivilegedChannel state)
           
 void setStaticData(ChannelStaticData sd)
          Passes ChannelStaticData to the channel.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TabColumnPrefsState

public TabColumnPrefsState()
                    throws PortalException

TabColumnPrefsState

public TabColumnPrefsState(CUserPreferences context)
                    throws PortalException
Method Detail

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException
Description copied from interface: IChannel
Passes ChannelStaticData to the channel. This is done during channel instantiation time. see org.jasig.portal.ChannelStaticData

Throws:
PortalException

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException
Description copied from interface: IChannel
Passes ChannelRuntimeData to the channel. This function is called prior to the renderXML() call.

Throws:
PortalException

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
                                throws PortalException
Description copied from interface: IPrivileged
Passes portal control structure to the channel.

Throws:
PortalException

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Description copied from interface: IChannel
Ask channel to render its content.

Throws:
PortalException

receiveEvent

public void receiveEvent(PortalEvent ev)
Description copied from interface: IChannel
Passes an outside event to a channel. Events should normally come from the LayoutBean.

Specified by:
receiveEvent in interface IChannel
Parameters:
ev - PortalEvent object
See Also:
PortalEvent

getRuntimeProperties

public ChannelRuntimeProperties getRuntimeProperties()
Description copied from interface: IChannel
Acquires ChannelRuntimeProperites from the channel. This function may be called by the portal framework throughout the session.

Specified by:
getRuntimeProperties in interface IChannel
See Also:
ChannelRuntimeProperties

setState

public void setState(IPrivilegedChannel state)

setContext

public void setContext(CUserPreferences context)

uPortal 2.4.1
API Documentation