Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.webapp.action
Class WebActionsBean

java.lang.Object
  extended by org.nuxeo.ecm.webapp.action.WebActionsBean
All Implemented Interfaces:
java.io.Serializable, WebActions, WebActionsLocal, StatefulBaseLifeCycle

@Name(value="webActions")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class WebActionsBean
extends java.lang.Object
implements WebActionsLocal, java.io.Serializable

Web actions bean that manages actions.

Implements specific behavior to handle special mechanism of the documents tabbed content.

Author:
Eugen Ionica, Anahide Tchertchian, Florent Guillaume, Catalin Baican
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.nuxeo.ecm.platform.ui.web.api.WebActions
NULL_TAB_ID
 
Constructor Summary
WebActionsBean()
           
 
Method Summary
 void destroy()
           
 java.util.List<Action> getActionsList(java.lang.String category)
           
 java.util.List<Action> getActionsList(java.lang.String category, ActionContext context)
           
 java.util.List<Action> getAllActions(java.lang.String category)
           
 java.lang.String getCurrentLifeCycleState()
          Deprecated. Unused
 Action getCurrentSubTabAction()
           
 java.lang.String getCurrentSubTabId()
           
 Action getCurrentTabAction()
           
 java.lang.String getCurrentTabId()
           
 java.util.List<Action> getSubTabsList()
           
 java.util.List<Action> getSubViewActionsList()
          Deprecated. 
 java.util.List<Action> getTabsList()
           
 java.util.List<Action> getUnfiltredActionsList(java.lang.String category)
           
 java.util.List<Action> getUnfiltredActionsList(java.lang.String category, ActionContext context)
           
 void initialize()
           
 void readState()
          Activate method.
 void resetCurrentTab()
           
 void resetTabList()
           
 void saveState()
          Passivate method.
 void selectTabAction()
           
 void setCurrentSubTabAction(Action tabAction)
           
 void setCurrentSubTabId(java.lang.String tabId)
           
 void setCurrentTabAction(Action currentTabAction)
           
 void setCurrentTabAction(java.lang.String currentTabActionId)
          Deprecated. 
 java.lang.String setCurrentTabAndNavigate(DocumentModel document, java.lang.String currentTabActionId)
          This method is used to nagivate to the given document and open the view page of the given document in the given tab argument.
 java.lang.String setCurrentTabAndNavigate(java.lang.String currentTabActionId)
           
 void setCurrentTabId(java.lang.String tabId)
           
 void setSubTabsList(java.util.List<Action> tabsList)
           
 void setTabsList(java.util.List<Action> tabsList)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebActionsBean

public WebActionsBean()
Method Detail

initialize

public void initialize()
Specified by:
initialize in interface WebActionsLocal

destroy

@Destroy
public void destroy()
Specified by:
destroy in interface WebActionsLocal

saveState

public void saveState()
Description copied from interface: StatefulBaseLifeCycle
Passivate method.

Specified by:
saveState in interface StatefulBaseLifeCycle

readState

public void readState()
Description copied from interface: StatefulBaseLifeCycle
Activate method.

Specified by:
readState in interface StatefulBaseLifeCycle

getActionsList

public java.util.List<Action> getActionsList(java.lang.String category,
                                             ActionContext context)
Specified by:
getActionsList in interface WebActions

getActionsList

public java.util.List<Action> getActionsList(java.lang.String category)
Specified by:
getActionsList in interface WebActions

getUnfiltredActionsList

public java.util.List<Action> getUnfiltredActionsList(java.lang.String category,
                                                      ActionContext context)
Specified by:
getUnfiltredActionsList in interface WebActions

getUnfiltredActionsList

public java.util.List<Action> getUnfiltredActionsList(java.lang.String category)
Specified by:
getUnfiltredActionsList in interface WebActions

getAllActions

public java.util.List<Action> getAllActions(java.lang.String category)
Specified by:
getAllActions in interface WebActions

getSubViewActionsList

@Deprecated
public java.util.List<Action> getSubViewActionsList()
Deprecated. 

Specified by:
getSubViewActionsList in interface WebActions

resetTabList

@Observer(value={"userAllDocumentTypesSelectionChanged","locationSelectionChanged"},
          create=false)
@BypassInterceptors
public void resetTabList()
Specified by:
resetTabList in interface WebActions

resetCurrentTab

public void resetCurrentTab()
Specified by:
resetCurrentTab in interface WebActions

getTabsList

@Factory(value="tabsActionsList",
         scope=EVENT)
public java.util.List<Action> getTabsList()
Specified by:
getTabsList in interface WebActions

getSubTabsList

@Factory(value="subTabsActionsList",
         scope=EVENT)
public java.util.List<Action> getSubTabsList()
Specified by:
getSubTabsList in interface WebActions

setTabsList

public void setTabsList(java.util.List<Action> tabsList)
Specified by:
setTabsList in interface WebActions

setSubTabsList

public void setSubTabsList(java.util.List<Action> tabsList)
Specified by:
setSubTabsList in interface WebActions

getCurrentTabAction

public Action getCurrentTabAction()
Specified by:
getCurrentTabAction in interface WebActions

setCurrentTabAction

public void setCurrentTabAction(Action currentTabAction)
Specified by:
setCurrentTabAction in interface WebActions

getCurrentSubTabAction

public Action getCurrentSubTabAction()
Specified by:
getCurrentSubTabAction in interface WebActions

setCurrentSubTabAction

public void setCurrentSubTabAction(Action tabAction)
Specified by:
setCurrentSubTabAction in interface WebActions

setCurrentTabAction

@Deprecated
public void setCurrentTabAction(java.lang.String currentTabActionId)
Deprecated. 

Specified by:
setCurrentTabAction in interface WebActions

getCurrentTabId

public java.lang.String getCurrentTabId()
Specified by:
getCurrentTabId in interface WebActions

setCurrentTabId

public void setCurrentTabId(java.lang.String tabId)
Specified by:
setCurrentTabId in interface WebActions

getCurrentSubTabId

public java.lang.String getCurrentSubTabId()
Specified by:
getCurrentSubTabId in interface WebActions

setCurrentSubTabId

public void setCurrentSubTabId(java.lang.String tabId)
Specified by:
setCurrentSubTabId in interface WebActions

setCurrentTabAndNavigate

public java.lang.String setCurrentTabAndNavigate(java.lang.String currentTabActionId)
Specified by:
setCurrentTabAndNavigate in interface WebActions

setCurrentTabAndNavigate

public java.lang.String setCurrentTabAndNavigate(DocumentModel document,
                                                 java.lang.String currentTabActionId)
Description copied from interface: WebActions
This method is used to nagivate to the given document and open the view page of the given document in the given tab argument.

Specified by:
setCurrentTabAndNavigate in interface WebActions
Parameters:
document - to document which will be shown in the view page
currentTabActionId - the tab which will be focused in the view page
Returns:
the path to the view page of the given document in the given tab.

selectTabAction

public void selectTabAction()
Specified by:
selectTabAction in interface WebActions

getCurrentLifeCycleState

@Deprecated
public java.lang.String getCurrentLifeCycleState()
                                          throws ClientException
Deprecated. Unused

Specified by:
getCurrentLifeCycleState in interface WebActions
Throws:
ClientException

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.