uPortal 2.4.1
API Documentation

org.jasig.portal.layout.channels.locales
Class CUserLocalesSelector

java.lang.Object
  extended byorg.jasig.portal.channels.BaseChannel
      extended byorg.jasig.portal.layout.channels.locales.CUserLocalesSelector
All Implemented Interfaces:
IChannel, IPrivileged

public class CUserLocalesSelector
extends BaseChannel
implements IPrivileged

Lets a user select his/her locale preference. The UI, for now, is limited. The user can only select one locale choice. The underlying APIs and data structures actually allow an "ordering" of locales, so this channel can be enhanced to allow the user to sort a list of locales.

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

Constructor Summary
CUserLocalesSelector()
           
 
Method Summary
 void renderXML(org.xml.sax.ContentHandler out)
          Ask channel to render its content.
 void setPortalControlStructures(PortalControlStructures pcs)
          Passes portal control structure to the channel.
 void setRuntimeData(ChannelRuntimeData runtimeData)
          Passes ChannelRuntimeData to the channel.
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CUserLocalesSelector

public CUserLocalesSelector()
Method Detail

setPortalControlStructures

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

Specified by:
setPortalControlStructures in interface IPrivileged
Throws:
PortalException
See Also:
PortalControlStructures

setRuntimeData

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

Specified by:
setRuntimeData in interface IChannel
Overrides:
setRuntimeData in class BaseChannel
Throws:
PortalException

renderXML

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

Specified by:
renderXML in interface IChannel
Overrides:
renderXML in class BaseChannel
Throws:
PortalException

uPortal 2.4.1
API Documentation