|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.DLMUserPreferences.BaseState
org.jasig.portal.channels.DLMUserPreferences.TabColumnPrefsState
public class TabColumnPrefsState
This user preferences component is for use with layouts based on the tab-column structure.
Nested Class Summary | |
---|---|
protected class |
TabColumnPrefsState.DefaultState
A sub-state of TabColumnPrefsState for visualizing the user layout in tab-column form. |
protected class |
TabColumnPrefsState.NewChannelState
A sub-state of TabColumnPrefsState for choosing a new channel (formerly subscribe) |
protected class |
TabColumnPrefsState.ParametersState
A sub-state of TabColumnPrefsState for setting channel parameters |
protected class |
TabColumnPrefsState.ResetLayoutState
A sub-state of TabColumnPrefsState for resetting layout |
protected class |
TabColumnPrefsState.SelectSkinsState
A sub-state of TabColumnPrefsState for selecting skins |
Field Summary | |
---|---|
private java.lang.String |
action
|
private java.lang.String |
activeTab
|
protected static java.lang.String |
BLANK_TAB_NAME
|
private static java.lang.String |
bundleBaseLocation
|
private UserProfile |
editedUserProfile
|
private java.lang.String |
elementID
|
private java.lang.String |
errorMessage
Configuration Object to read resource bundle property values for I18N |
private static java.lang.String |
errorMessageAddTab
|
private static java.lang.String |
errorMessageChangeColumnWidths
|
private static java.lang.String |
errorMessageDeleteChannel
|
private static java.lang.String |
errorMessageDeleteColumn
|
private static java.lang.String |
errorMessageDeleteTab
|
private static java.lang.String |
errorMessageLockTab
|
private static java.lang.String |
errorMessageModChannelParams
|
private static java.lang.String |
errorMessageMoveChannel
|
private static java.lang.String |
errorMessageMoveColumn
|
private static java.lang.String |
errorMessageMoveTab
|
private static java.lang.String |
errorMessageNewChannel
|
private static java.lang.String |
errorMessageNewColumn
|
private static java.lang.String |
errorMessageRenameTab
|
private static java.lang.String |
errorMessageSetActiveTab
|
private static java.lang.String |
errorMessageUnlockTab
|
private static org.apache.commons.logging.Log |
log
|
private PortalControlStructures |
pcs
|
protected ChannelRuntimeData |
runtimeData
|
private StylesheetSet |
set
|
protected static java.lang.String |
SKIN_LIST_FILE
|
private static java.lang.String |
sslLocation
|
protected ChannelStaticData |
staticData
|
private IUserLayoutManager |
ulm
|
private static IUserLayoutStore |
ulStore
|
private UserPreferences |
userPrefs
|
Fields inherited from class org.jasig.portal.channels.DLMUserPreferences.BaseState |
---|
context, internalState |
Constructor Summary | |
---|---|
TabColumnPrefsState()
|
|
TabColumnPrefsState(CUserPreferences context)
|
Method Summary | |
---|---|
private void |
addChannel(org.w3c.dom.Element newChannel,
java.lang.String position,
java.lang.String destinationElementId)
Adds a channel to the layout. |
private void |
addChannel(java.lang.String selectedChannelSubscribeId,
java.lang.String position,
java.lang.String destinationElementId)
Adds a channel to the layout. |
private void |
addColumn(java.lang.String method,
java.lang.String destinationElementId)
Adds a new column into the layout. |
private void |
addTab(java.lang.String tabName,
java.lang.String method,
java.lang.String destinationTabId)
Adds a new tab to the layout. |
private void |
changeColumnWidths(java.util.HashMap columnWidths)
|
private void |
changeRestrictions(java.lang.String id,
java.lang.String moveAllowed,
java.lang.String editAllowed,
java.lang.String addChildAllowed,
java.lang.String deleteAllowed)
|
private IUserLayoutFolderDescription |
createFolder(java.lang.String name)
Creates a folder element with default attributes. |
private void |
deleteChannel(java.lang.String channelSubscribeId)
Removes a channel element from the layout |
private void |
deleteElement(java.lang.String elementId)
Removes a tab or column element from the layout. |
private java.lang.String |
getActiveTab()
|
private java.util.List |
getOverridableChannelParams(java.lang.String channelPublishId)
Finds any parameters in a channel that are determined to be overridable by a user. |
private boolean |
getRestriction(java.lang.String val)
|
private IUserLayoutManager |
getUserLayoutManager()
|
private boolean |
isColumn(java.lang.String folderId)
A folder is a column if its parent is a tab element |
private boolean |
isTab(java.lang.String folderId)
A folder is a tab if its parent element is the layout element |
private boolean |
modifyingCurrentUserLayout()
|
private void |
moveChannel(java.lang.String sourceChannelSubscribeId,
java.lang.String method,
java.lang.String destinationElementId)
Moves a channel from one position in the layout to another. |
private void |
moveColumn(java.lang.String sourceId,
java.lang.String method,
java.lang.String destinationId)
Moves a column from one position in the layout to another. |
private void |
moveTab(java.lang.String sourceTabId,
java.lang.String method,
java.lang.String destinationTabId)
|
private void |
renameTab(java.lang.String tabId,
java.lang.String tabName)
|
void |
renderXML(org.xml.sax.ContentHandler out)
Ask channel to render its content. |
private void |
saveLayout(boolean channelsAdded)
|
private void |
saveUserPreferences()
|
private void |
setActiveTab(java.lang.String activeTab)
|
void |
setPortalControlStructures(PortalControlStructures pcs)
Passes portal control structure to the channel. |
void |
setRuntimeData(ChannelRuntimeData rd)
Passes ChannelRuntimeData to the channel. |
void |
setStaticData(ChannelStaticData sd)
Passes ChannelStaticData to the channel. |
private void |
updateTabLock(java.lang.String elementId,
boolean locked)
|
Methods inherited from class org.jasig.portal.channels.DLMUserPreferences.BaseState |
---|
getRuntimeProperties, receiveEvent, setContext, setState |
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
protected ChannelStaticData staticData
protected ChannelRuntimeData runtimeData
private static final java.lang.String sslLocation
private static final java.lang.String bundleBaseLocation
private IUserLayoutManager ulm
private PortalControlStructures pcs
private UserPreferences userPrefs
private UserProfile editedUserProfile
private static IUserLayoutStore ulStore
private StylesheetSet set
private java.lang.String action
private java.lang.String activeTab
private java.lang.String elementID
protected static java.lang.String BLANK_TAB_NAME
protected static java.lang.String SKIN_LIST_FILE
private java.lang.String errorMessage
private static final java.lang.String errorMessageSetActiveTab
private static final java.lang.String errorMessageRenameTab
private static final java.lang.String errorMessageMoveTab
private static final java.lang.String errorMessageAddTab
private static final java.lang.String errorMessageDeleteTab
private static final java.lang.String errorMessageLockTab
private static final java.lang.String errorMessageUnlockTab
private static final java.lang.String errorMessageChangeColumnWidths
private static final java.lang.String errorMessageMoveColumn
private static final java.lang.String errorMessageNewColumn
private static final java.lang.String errorMessageDeleteColumn
private static final java.lang.String errorMessageNewChannel
private static final java.lang.String errorMessageModChannelParams
private static final java.lang.String errorMessageMoveChannel
private static final java.lang.String errorMessageDeleteChannel
Constructor Detail |
---|
public TabColumnPrefsState() throws PortalException
PortalException
public TabColumnPrefsState(CUserPreferences context) throws PortalException
PortalException
Method Detail |
---|
public void setStaticData(ChannelStaticData sd) throws PortalException
IChannel
setStaticData
in interface IChannel
setStaticData
in class BaseState
sd
- channel static data
PortalException
ChannelStaticData
public void setRuntimeData(ChannelRuntimeData rd) throws PortalException
IChannel
setRuntimeData
in interface IChannel
setRuntimeData
in class BaseState
rd
- channel runtime data
PortalException
ChannelRuntimeData
public void setPortalControlStructures(PortalControlStructures pcs) throws PortalException
IPrivileged
setPortalControlStructures
in interface IPrivileged
setPortalControlStructures
in class BaseState
PortalException
PortalControlStructures
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
private final IUserLayoutManager getUserLayoutManager() throws java.lang.Exception
java.lang.Exception
private final java.lang.String getActiveTab()
private final void setActiveTab(java.lang.String activeTab) throws java.lang.Exception
java.lang.Exception
private final void renameTab(java.lang.String tabId, java.lang.String tabName) throws PortalException
PortalException
private boolean getRestriction(java.lang.String val)
private final void changeRestrictions(java.lang.String id, java.lang.String moveAllowed, java.lang.String editAllowed, java.lang.String addChildAllowed, java.lang.String deleteAllowed) throws java.lang.Exception
java.lang.Exception
private final void moveTab(java.lang.String sourceTabId, java.lang.String method, java.lang.String destinationTabId) throws PortalException
PortalException
private final void addTab(java.lang.String tabName, java.lang.String method, java.lang.String destinationTabId) throws PortalException
tabName
- the name of the tabmethod
- either insertBefore
or appendAfter
destinationTabId
- the column to insert the new column before or append after (may actually be a tab)
PortalException
private final void addColumn(java.lang.String method, java.lang.String destinationElementId) throws java.lang.Exception
method
- either insertBefore
or appendAfter
destinationElementId
- the column to insert the new column before or append after (may actually be a tab)
java.lang.Exception
private final void changeColumnWidths(java.util.HashMap columnWidths) throws java.lang.Exception
java.lang.Exception
private final void moveColumn(java.lang.String sourceId, java.lang.String method, java.lang.String destinationId) throws PortalException
sourceId
- the column to move (may actually be a tab)method
- either insertBefore
or appendAfter
destinationId
- the column to insert the new column before or append after (may actually be a tab)
PortalException
private final void moveChannel(java.lang.String sourceChannelSubscribeId, java.lang.String method, java.lang.String destinationElementId) throws PortalException
sourceChannelSubscribeId
- the channel to movemethod
- either insertBefore
or appendAfter
destinationElementId
- the ID of the channel to insert the new channel before or append after
PortalException
private final void addChannel(org.w3c.dom.Element newChannel, java.lang.String position, java.lang.String destinationElementId) throws PortalException
newChannel
- the channel to addposition
- either before
or after
destinationElementId
- the ID of the channel to insert the new channel before or append after
PortalException
private final void addChannel(java.lang.String selectedChannelSubscribeId, java.lang.String position, java.lang.String destinationElementId) throws java.lang.Exception
selectedChannelSubscribeId
- the channel to addposition
- either before
or after
destinationElementId
- the ID of the channel to insert the new channel before or append after
java.lang.Exception
private final void deleteChannel(java.lang.String channelSubscribeId) throws java.lang.Exception
channelSubscribeId
- the ID attribute of the channel to remove
java.lang.Exception
private final void deleteElement(java.lang.String elementId) throws java.lang.Exception
elementId
- the ID attribute of the element to remove
java.lang.Exception
private final void updateTabLock(java.lang.String elementId, boolean locked) throws java.lang.Exception
java.lang.Exception
private final boolean isTab(java.lang.String folderId) throws PortalException
folder
- the folder in question
true
if the folder is a tab, otherwise false
PortalException
private final boolean isColumn(java.lang.String folderId) throws PortalException
folder
- the folder in question
true
if the folder is a column, otherwise false
PortalException
private final IUserLayoutFolderDescription createFolder(java.lang.String name)
name
- the tab name for tabs and an empty string for columns
private final java.util.List getOverridableChannelParams(java.lang.String channelPublishId) throws PortalException
channelPublishId
- an identifier to find the selected channel within the channel registry
PortalException
private void saveLayout(boolean channelsAdded) throws PortalException
PortalException
private void saveUserPreferences() throws PortalException
PortalException
private boolean modifyingCurrentUserLayout() throws PortalException
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |