|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.UserPreferences.BaseState
org.jasig.portal.channels.UserPreferences.GPreferencesState
class GPreferencesState
Manages User Layout and user stylesheet preferences
This is a general UserPreference component. A structure/theme stylesheet is expected to replace this component with its own class to make layout/stylesheet preference management more intuitive.
Nested Class Summary | |
---|---|
protected class |
GPreferencesState.GBrowseState
|
protected class |
GPreferencesState.GEditLayoutItemState
|
protected class |
GPreferencesState.GGlobalPrefsState
|
protected class |
GPreferencesState.GMoveToState
|
Field Summary | |
---|---|
private java.lang.String |
folderID
|
private static org.apache.commons.logging.Log |
log
|
private boolean |
modified
|
private UserProfile |
profile
|
protected ChannelRuntimeData |
runtimeData
|
(package private) StructureStylesheetDescription |
ssd
|
(package private) ThemeStylesheetDescription |
tsd
|
private IUserLayoutManager |
ulm
|
protected IUserLayoutStore |
ulsdb
|
private UserPreferences |
up
|
Fields inherited from class org.jasig.portal.channels.UserPreferences.BaseState |
---|
context, internalState |
Constructor Summary | |
---|---|
GPreferencesState()
|
|
GPreferencesState(CUserPreferences context)
Creates a new GPreferencesState for a given context. |
|
GPreferencesState(CUserPreferences context,
UserProfile p)
|
Method Summary | |
---|---|
protected java.lang.String |
getFolderID()
Obtain current folderId |
protected java.lang.String |
getLayoutRootID()
|
protected UserProfile |
getProfile()
|
protected StructureStylesheetDescription |
getStructureStylesheetDescription()
|
protected StylesheetSet |
getStylesheetSet()
|
protected ThemeStylesheetDescription |
getThemeStylesheetDescription()
|
protected IUserLayoutManager |
getUserLayoutManager()
|
protected UserPreferences |
getUserPreferences()
|
protected IUserPreferencesManager |
getUserPreferencesManager()
|
protected boolean |
isModified()
Check if the user layout or preferences have been modified. |
private boolean |
modifyingCurrentUserLayout()
|
void |
renderXML(org.xml.sax.ContentHandler out)
Ask channel to render its content. |
protected void |
setFolderID(java.lang.String id)
Set current folderId. |
protected void |
setModified(boolean mod)
Set modification state |
void |
setPortalControlStructures(PortalControlStructures pcs)
Passes portal control structure to the channel. |
void |
setRuntimeData(ChannelRuntimeData rd)
Passes ChannelRuntimeData to the channel. |
Methods inherited from class org.jasig.portal.channels.UserPreferences.BaseState |
---|
getRuntimeProperties, receiveEvent, setContext, setState, setStaticData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final org.apache.commons.logging.Log log
private UserProfile profile
protected ChannelRuntimeData runtimeData
private UserPreferences up
private IUserLayoutManager ulm
ThemeStylesheetDescription tsd
StructureStylesheetDescription ssd
protected IUserLayoutStore ulsdb
private java.lang.String folderID
private boolean modified
Constructor Detail |
---|
public GPreferencesState()
public GPreferencesState(CUserPreferences context)
GPreferencesState
for a given context.
context
- a CUserPreferences
valuepublic GPreferencesState(CUserPreferences context, UserProfile p)
Method Detail |
---|
protected boolean isModified()
boolean
valueprotected void setModified(boolean mod)
mod
- a boolean
valueprotected void setFolderID(java.lang.String id)
id
- a String
valueprotected java.lang.String getFolderID()
String
valueprotected java.lang.String getLayoutRootID()
protected IUserLayoutManager getUserLayoutManager() throws PortalException
PortalException
private boolean modifyingCurrentUserLayout() throws PortalException
PortalException
protected IUserPreferencesManager getUserPreferencesManager()
protected UserPreferences getUserPreferences() throws ResourceMissingException, PortalException
ResourceMissingException
PortalException
protected ThemeStylesheetDescription getThemeStylesheetDescription() throws PortalException
PortalException
protected StructureStylesheetDescription getStructureStylesheetDescription() throws ResourceMissingException, PortalException
ResourceMissingException
PortalException
public void setPortalControlStructures(PortalControlStructures pcs) throws PortalException
IPrivileged
setPortalControlStructures
in interface IPrivileged
setPortalControlStructures
in class BaseState
PortalException
PortalControlStructures
protected StylesheetSet getStylesheetSet()
protected UserProfile getProfile()
public void setRuntimeData(ChannelRuntimeData rd) throws PortalException
IChannel
setRuntimeData
in interface IChannel
setRuntimeData
in class BaseState
rd
- channel runtime data
PortalException
ChannelRuntimeData
public void renderXML(org.xml.sax.ContentHandler out) throws PortalException
IChannel
renderXML
in interface IChannel
renderXML
in class BaseState
out
- the SAX ContentHandler to output content to
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |