org.nuxeo.ecm.platform.ui.web.api
Interface WebActions

All Known Subinterfaces:

WebActionsLocal

All Known Implementing Classes:

WebActionsBean

public interface WebActions

Author:

Anahide Tchertchian

Field Summary

static java.lang.String

NULL_TAB_ID

Method Summary

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. should be handled by a workflow related (or at least document) action listener.
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	resetCurrentTab()
void	resetTabList()
void	selectTabAction()
void	setCurrentSubTabAction(Action tabAction)
void	setCurrentSubTabId(java.lang.String tabId)
void	setCurrentTabAction(Action tabAction)
void	setCurrentTabAction(java.lang.String currentTabActionId) Deprecated. use getCurrentTabId()
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)

Field Detail

NULL_TAB_ID

static final java.lang.String NULL_TAB_ID

See Also:

Constant Field Values

Method Detail

getActionsList

java.util.List<Action> getActionsList(java.lang.String category,
                                      ActionContext context)

getActionsList

java.util.List<Action> getActionsList(java.lang.String category)

getUnfiltredActionsList

java.util.List<Action> getUnfiltredActionsList(java.lang.String category,
                                               ActionContext context)

getUnfiltredActionsList

java.util.List<Action> getUnfiltredActionsList(java.lang.String category)

getAllActions

java.util.List<Action> getAllActions(java.lang.String category)

getSubViewActionsList

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

Deprecated.

getTabsList

java.util.List<Action> getTabsList()

setTabsList

void setTabsList(java.util.List<Action> tabsList)

getSubTabsList

java.util.List<Action> getSubTabsList()

setSubTabsList

void setSubTabsList(java.util.List<Action> tabsList)

getCurrentTabAction

Action getCurrentTabAction()

setCurrentTabAction

void setCurrentTabAction(Action tabAction)

getCurrentSubTabAction

Action getCurrentSubTabAction()

setCurrentSubTabAction

void setCurrentSubTabAction(Action tabAction)

setCurrentTabAction

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

Deprecated. use getCurrentTabId()

getCurrentTabId

java.lang.String getCurrentTabId()

setCurrentTabId

void setCurrentTabId(java.lang.String tabId)

getCurrentSubTabId

java.lang.String getCurrentSubTabId()

setCurrentSubTabId

void setCurrentSubTabId(java.lang.String tabId)

selectTabAction

void selectTabAction()

resetTabList

void resetTabList()

resetCurrentTab

void resetCurrentTab()

setCurrentTabAndNavigate

java.lang.String setCurrentTabAndNavigate(java.lang.String currentTabActionId)

setCurrentTabAndNavigate

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.

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.

getCurrentLifeCycleState

@Deprecated
java.lang.String getCurrentLifeCycleState()
                                          throws java.lang.Exception

Deprecated. should be handled by a workflow related (or at least document) action listener.

Throws:

java.lang.Exception