WebActions (Nuxeo ECM Projects 9.10-SNAPSHOT API)

All Known Implementing Classes:

WebActionsBean
```
public interface WebActions
```
Component that handles actions retrieval as well as current tab(s) selection.

Author:

Anahide Tchertchian

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AJAX_TAB_PROPERTY` Framework property to control ajaxified behaviour of document tabs.
`static String`	`CURRENT_TAB_CHANGED_EVENT` Event raised when the current tab has changed, with 2 parameters: first parameter is a String representing the tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for this category).
`static String`	`CURRENT_TAB_SELECTED_EVENT` Event raised when the current tab is selected, with 2 parameters: first parameter is a String representing the tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for this category).
`static String`	`DEFAULT_TABS_CATEGORY` The category of actions for default tabs
`static String`	`DOCUMENTS_MAIN_TAB_ID` Identifier of main tab for the "Documents management" area
`static String`	`MAIN_TAB_ID_PARAMETER` Request parameter used for main tab id settings
`static String`	`MAIN_TABS_CATEGORY` The category of actions for main tabs
`static String`	`NULL_TAB_ID`
`static String`	`SUBTAB_CATEGORY_SUFFIX`
`static String`	`TAB_IDS_PARAMETER` Request parameter used for tab ids settings

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canUseAjaxTabs()` Returns true if history push state is supported by browser.
`boolean`	`checkFilter(String filterId)`
`Action`	`getAction(ActionContext context, String actionId, boolean includeFiltered, boolean postFilter)` Return action in given action context for given id.
`Action`	`getAction(String actionId, ActionContext context, boolean removeFiltered)`
`Action`	`getAction(String actionId, boolean removeFiltered)`
`Action`	`getActionForDocument(String actionId, DocumentModel document, boolean removeFiltered)` Return action with given id, with context filled with given document.
`List<Action>`	`getActions(ActionContext context, String category, boolean includeFiltered, boolean postFilter)` Return actions in given action context for given category.
`List<Action>`	`getActionsList(String category)` Returns all filtered actions for a given category, creating a new context for the filters resolution.
`List<Action>`	`getActionsList(String category, ActionContext context)` Returns all filtered actions for a given category and given resolution context.
`List<Action>`	`getActionsList(String category, ActionContext context, boolean removeFiltered)` Returns all filtered actions for a given category and given resolution context.
`List<Action>`	`getActionsList(String category, Boolean removeFiltered)` Returns all filtered actions for a given category and given resolution context, creating a new context for the filters resolution.
`List<Action>`	`getActionsListForDocument(String category, DocumentModel document, boolean removeFiltered)` Returns all filtered actions for a given category and a context built with given current document context, creating a new context for the filters resolution.
`List<Action>`	`getAllActions(String category)` Returns all actions for a given category, without filtering.
`Action`	`getCurrentSubTabAction()` Returns the current sub tab for a category computed from the current tab action id and the suffix `SUBTAB_CATEGORY_SUFFIX`.
`Action`	`getCurrentSubTabAction(String parentActionId)` Returns the current sub tab action for given parent action, computing the category from parent action id with suffix `SUBTAB_CATEGORY_SUFFIX`.
`String`	`getCurrentSubTabId()` Returns the current sub tab id for a category computed from the current tab action id and the suffix `SUBTAB_CATEGORY_SUFFIX`.
`Action`	`getCurrentTabAction()` Returns the current action for category `DEFAULT_TABS_CATEGORY`
`Action`	`getCurrentTabAction(String category)` Returns the current action for given category.
`String`	`getCurrentTabId()` Returns the current action id for category `DEFAULT_TABS_CATEGORY`
`String`	`getCurrentTabId(String category)` Returns the current action id for given category
`String`	`getCurrentTabIds()` Returns current tab ids as a string, encoded as is: CATEGORY_1:ACTION_ID_1,CATEGORY_2:ACTION_ID_2,...
`Action`	`getDocumentAction(DocumentModel document, String actionId, boolean includeFiltered, boolean postFilter)` Return action in given document context for given id.
`List<Action>`	`getDocumentActions(DocumentModel document, String category, boolean removeFiltered, boolean postFilter)` Return actions in given document context for given category.
`List<Action>`	`getSubTabsList()` Returns filtered actions for a category computed from the current tab action id and the suffix `SUBTAB_CATEGORY_SUFFIX`.
`List<Action>`	`getTabsList()` Returns filtered actions for the category `DEFAULT_TABS_CATEGORY`
`boolean`	`hasCurrentTabId(String category)` Indicates if the current tab id is set for given category
`boolean`	`isAvailable(ActionContext context, Action action)` Returns true if filters evaluation for given action, in given action context, grants access.
`boolean`	`isAvailableForDocument(DocumentModel document, Action action)` Returns true if filters evaluation for given action, in given document context, grants access.
`void`	`resetCurrentTab()` Resets current tab information (includes sub tab information) for category `DEFAULT_TABS_CATEGORY`.
`void`	`resetCurrentTabs()` Resets all current tabs information.
`void`	`resetCurrentTabs(String category)` Resets current tabs for given category, taking subtabs into account by resetting actions in categories computed from reset actions id with suffix `SUBTAB_CATEGORY_SUFFIX`.
`void`	`resetTabList()` Resets actions resolved for category `DEFAULT_TABS_CATEGORY` so that they're recomputed.
`void`	`setCurrentSubTabAction(Action tabAction)` Sets the current sub tab for a category computed from the current tab action id and the suffix `SUBTAB_CATEGORY_SUFFIX`.
`void`	`setCurrentSubTabId(String tabId)` Sets the current sub tab id for a category computed from the current tab action id and the suffix `SUBTAB_CATEGORY_SUFFIX`.
`void`	`setCurrentTabAction(Action tabAction)` Sets the current action for category `DEFAULT_TABS_CATEGORY`
`void`	`setCurrentTabAction(String category, Action tabAction)` Sets the current action for given category.
`String`	`setCurrentTabAndNavigate(DocumentModel document, String currentTabActionId)` Navigate to the given document and opens the view page of the given document selecting the given tab.
`String`	`setCurrentTabAndNavigate(String currentTabActionId)` Calls `setCurrentTabAndNavigate(DocumentModel, String)` for the current document.
`void`	`setCurrentTabId(String tabId)` Sets the current action id for category `DEFAULT_TABS_CATEGORY`.
`void`	`setCurrentTabId(String category, String tabId, String... subTabIds)` Sets the current action for given category, with additional sub tabs.
`void`	`setCurrentTabIds(String tabIds)` Sets current tab ids as a String, splitting on commas ',' and parsing each action information as is: CATEGORY:ACTION_ID[:OPTIONAL_SUB_ACTION_ID[:OPTIONAL_SUB_ACTION_ID]...]
`boolean`	`useAjaxTabs()` Returns true if ajaxified behaviour of tabs is activated on the server, and if history push state is supported by browser.

- Field Detail
  - NULL_TAB_ID
```
static final String NULL_TAB_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TABS_CATEGORY
```
static final String DEFAULT_TABS_CATEGORY
```
    The category of actions for default tabs
    
    See Also:
    
    Constant Field Values
  - MAIN_TABS_CATEGORY
```
static final String MAIN_TABS_CATEGORY
```
    The category of actions for main tabs
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - SUBTAB_CATEGORY_SUFFIX
```
static final String SUBTAB_CATEGORY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - DOCUMENTS_MAIN_TAB_ID
```
static final String DOCUMENTS_MAIN_TAB_ID
```
    Identifier of main tab for the "Documents management" area
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - TAB_IDS_PARAMETER
```
static final String TAB_IDS_PARAMETER
```
    Request parameter used for tab ids settings
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - MAIN_TAB_ID_PARAMETER
```
static final String MAIN_TAB_ID_PARAMETER
```
    Request parameter used for main tab id settings
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - CURRENT_TAB_CHANGED_EVENT
```
static final String CURRENT_TAB_CHANGED_EVENT
```
    Event raised when the current tab has changed, with 2 parameters: first parameter is a String representing the tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for this category).
    
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
  - CURRENT_TAB_SELECTED_EVENT
```
static final String CURRENT_TAB_SELECTED_EVENT
```
    Event raised when the current tab is selected, with 2 parameters: first parameter is a String representing the tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for this category).
    This event is sent also when current tab did not change.
    
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - AJAX_TAB_PROPERTY
```
static final String AJAX_TAB_PROPERTY
```
    Framework property to control ajaxified behaviour of document tabs.
    
    Since:
    
    5.8
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDocumentActions
```
List<Action> getDocumentActions(DocumentModel document,
                                String category,
                                boolean removeFiltered,
                                boolean postFilter)
```
    Return actions in given document context for given category.
    
    Parameters:
    
    removeFiltered: - if true, do not return filtered actions. Useful to display filtered actions as disabled (by using using value false).
    
    postFilter: - if true, do not filter actions. Actions will need to be filtered or disabled at render time. Useful to filter actions when filtering context is available at render time only (for instance when displaying actions in listings inside a JSF iteration done at render time).
    
    Since:
    
    8.2
  - getDocumentAction
```
Action getDocumentAction(DocumentModel document,
                         String actionId,
                         boolean includeFiltered,
                         boolean postFilter)
```
    Return action in given document context for given id.
    Returns null if action is not found or filtered (depending on additional parameters).
    
    Parameters:
    
    removeFiltered: - if true, do not return filtered actions. Useful to display filtered actions as disabled (by using using value false).
    
    postFilter: - if true, do not filter actions. Actions will need to be filtered or disabled at render time. Useful to filter actions when filtering context is available at render time only (for instance when displaying actions in listings inside a JSF iteration done at render time).
    
    Since:
    
    8.2
  - getActions
```
List<Action> getActions(ActionContext context,
                        String category,
                        boolean includeFiltered,
                        boolean postFilter)
```
    Return actions in given action context for given category.
    
    Parameters:
    
    removeFiltered: - if true, do not return filtered actions. Useful to display filtered actions as disabled (by using using value false).
    
    postFilter: - if true, do not filter actions. Actions will need to be filtered or disabled at render time. Useful to filter actions when filtering context is available at render time only (for instance when displaying actions in listings inside a JSF iteration done at render time).
    
    Since:
    
    8.2
  - getAction
```
Action getAction(ActionContext context,
                 String actionId,
                 boolean includeFiltered,
                 boolean postFilter)
```
    Return action in given action context for given id.
    Returns null if action is not found or filtered (depending on additional parameters).
    
    Parameters:
    
    removeFiltered: - if true, do not return filtered actions. Useful to display filtered actions as disabled (by using using value false).
    
    postFilter: - if true, do not filter actions. Actions will need to be filtered or disabled at render time. Useful to filter actions when filtering context is available at render time only (for instance when displaying actions in listings inside a JSF iteration done at render time).
    
    Since:
    
    8.2
  - isAvailableForDocument
```
boolean isAvailableForDocument(DocumentModel document,
                               Action action)
```
    Returns true if filters evaluation for given action, in given document context, grants access.
    
    Since:
    
    8.2
  - isAvailable
```
boolean isAvailable(ActionContext context,
                    Action action)
```
    Returns true if filters evaluation for given action, in given action context, grants access.
    
    Since:
    
    8.2
  - getActionsList
```
List<Action> getActionsList(String category,
                            ActionContext context)
```
    Returns all filtered actions for a given category and given resolution context.
    Actions are filtered according to filters set on the actions definitions.
    Since 5.8, the category can be a list of categories, separated by commas.
  - getActionsList
```
List<Action> getActionsList(String category,
                            Boolean removeFiltered)
```
    Returns all filtered actions for a given category and given resolution context, creating a new context for the filters resolution.
    Actions are filtered according to filters set on the actions definitions.
    Since 5.8, the category can be a list of categories, separated by commas.
    
    Since:
    
    5.7
  - getActionsListForDocument
```
List<Action> getActionsListForDocument(String category,
                                       DocumentModel document,
                                       boolean removeFiltered)
```
    Returns all filtered actions for a given category and a context built with given current document context, creating a new context for the filters resolution.
    Actions are filtered according to filters set on the actions definitions.
    Since 5.8, the category can be a list of categories, separated by commas.
    
    Since:
    
    5.7.3
  - getActionsList
```
List<Action> getActionsList(String category,
                            ActionContext context,
                            boolean removeFiltered)
```
    Returns all filtered actions for a given category and given resolution context.
    Actions are filtered according to filters set on the actions definitions.
    Since 5.8, the category can be a list of categories, separated by commas.
    
    Since:
    
    5.7
  - getActionsList
```
List<Action> getActionsList(String category)
```
    Returns all filtered actions for a given category, creating a new context for the filters resolution.
    Since 5.8, the category can be a list of categories, separated by commas.
    
    See Also:
    
    getActionsList(String, ActionContext)
  - getAllActions
```
List<Action> getAllActions(String category)
```
    Returns all actions for a given category, without filtering.
  - getTabsList
```
List<Action> getTabsList()
```
    Returns filtered actions for the category DEFAULT_TABS_CATEGORY
  - getSubTabsList
```
List<Action> getSubTabsList()
```
    Returns filtered actions for a category computed from the current tab action id and the suffix SUBTAB_CATEGORY_SUFFIX.
  - getCurrentTabAction
```
Action getCurrentTabAction()
```
    Returns the current action for category DEFAULT_TABS_CATEGORY
  - setCurrentTabAction
```
void setCurrentTabAction(Action tabAction)
```
    Sets the current action for category DEFAULT_TABS_CATEGORY
  - getCurrentSubTabAction
```
Action getCurrentSubTabAction()
```
    Returns the current sub tab for a category computed from the current tab action id and the suffix SUBTAB_CATEGORY_SUFFIX.
  - setCurrentSubTabAction
```
void setCurrentSubTabAction(Action tabAction)
```
    Sets the current sub tab for a category computed from the current tab action id and the suffix SUBTAB_CATEGORY_SUFFIX.
  - getCurrentTabId
```
String getCurrentTabId()
```
    Returns the current action id for category DEFAULT_TABS_CATEGORY
  - setCurrentTabId
```
void setCurrentTabId(String tabId)
```
    Sets the current action id for category DEFAULT_TABS_CATEGORY.
    Does nothing if tabId is null, but resets current tab for this category when using an empty string instead.
  - getCurrentSubTabId
```
String getCurrentSubTabId()
```
    Returns the current sub tab id for a category computed from the current tab action id and the suffix SUBTAB_CATEGORY_SUFFIX.
  - setCurrentSubTabId
```
void setCurrentSubTabId(String tabId)
```
    Sets the current sub tab id for a category computed from the current tab action id and the suffix SUBTAB_CATEGORY_SUFFIX.
    Does nothing if sub tab id is null, but resets current tab for this category when using an empty string instead.
  - resetTabList
```
void resetTabList()
```
    Resets actions resolved for category DEFAULT_TABS_CATEGORY so that they're recomputed. Also calls resetCurrentTab()
  - resetCurrentTab
```
void resetCurrentTab()
```
    Resets current tab information (includes sub tab information) for category DEFAULT_TABS_CATEGORY.
  - getCurrentTabAction
```
Action getCurrentTabAction(String category)
```
    Returns the current action for given category.
  - getCurrentSubTabAction
```
Action getCurrentSubTabAction(String parentActionId)
```
    Returns the current sub tab action for given parent action, computing the category from parent action id with suffix SUBTAB_CATEGORY_SUFFIX.
  - setCurrentTabAction
```
void setCurrentTabAction(String category,
                         Action tabAction)
```
    Sets the current action for given category.
    If given action is null, it resets the current action for this category.
  - getCurrentTabId
```
String getCurrentTabId(String category)
```
    Returns the current action id for given category
  - hasCurrentTabId
```
boolean hasCurrentTabId(String category)
```
    Indicates if the current tab id is set for given category
    
    Since:
    
    5.5
  - setCurrentTabId
```
void setCurrentTabId(String category,
                     String tabId,
                     String... subTabIds)
```
    Sets the current action for given category, with additional sub tabs.
  - getCurrentTabIds
```
String getCurrentTabIds()
```
    Returns current tab ids as a string, encoded as is: CATEGORY_1:ACTION_ID_1,CATEGORY_2:ACTION_ID_2,...
    
    Since:
    
    5.4.2
  - setCurrentTabIds
```
void setCurrentTabIds(String tabIds)
```
    Sets current tab ids as a String, splitting on commas ',' and parsing each action information as is: CATEGORY:ACTION_ID[:OPTIONAL_SUB_ACTION_ID[:OPTIONAL_SUB_ACTION_ID]...]
    If category is omitted or empty, the category DEFAULT_TABS_CATEGORY will be used (if there is no subtab information).
    The resulting string looks like: CATEGORY_1:ACTION_ID_1,CATEGORY_2:ACTION_ID_2_SUB_ACTION_ID_2,...
    
    Since:
    
    5.4.2
  - resetCurrentTabs
```
void resetCurrentTabs()
```
    Resets all current tabs information.
    
    Since:
    
    5.4.2
  - resetCurrentTabs
```
void resetCurrentTabs(String category)
```
    Resets current tabs for given category, taking subtabs into account by resetting actions in categories computed from reset actions id with suffix SUBTAB_CATEGORY_SUFFIX.
  - setCurrentTabAndNavigate
```
String setCurrentTabAndNavigate(String currentTabActionId)
```
    Calls setCurrentTabAndNavigate(DocumentModel, String) for the current document.
    Given action should hold the category DEFAULT_TABS_CATEGORY
    
    See Also:
    
    NavigationContext.getCurrentDocument()
  - setCurrentTabAndNavigate
```
String setCurrentTabAndNavigate(DocumentModel document,
                                String currentTabActionId)
```
    Navigate to the given document and opens the view page of the given document selecting the given tab.
    Given action should hold the category DEFAULT_TABS_CATEGORY
    
    Parameters:
    
    document - to document which will be shown in the view page
    
    currentTabActionId - the tab that will be selected in the view page
    
    Returns:
    
    the JSF view for the given document.
  - checkFilter
```
boolean checkFilter(String filterId)
```
    Since:
    
    5.6
    
    See Also:
    
    ActionManager.checkFilter(String, ActionContext)
  - getAction
```
Action getAction(String actionId,
                 boolean removeFiltered)
```
    Since:
    
    5.7
    
    See Also:
    
    ActionManager.getAction(String, ActionContext, boolean)
  - getActionForDocument
```
Action getActionForDocument(String actionId,
                            DocumentModel document,
                            boolean removeFiltered)
```
    Return action with given id, with context filled with given document.
    
    Since:
    
    5.7.3
    
    See Also:
    
    ActionManager.getAction(String, ActionContext, boolean)
  - getAction
```
Action getAction(String actionId,
                 ActionContext context,
                 boolean removeFiltered)
```
    Since:
    
    5.6
    
    See Also:
    
    ActionManager.getAction(String, ActionContext, boolean)
  - useAjaxTabs
```
boolean useAjaxTabs()
```
    Returns true if ajaxified behaviour of tabs is activated on the server, and if history push state is supported by browser.
    
    Since:
    
    5.8
    
    See Also:
    
    AJAX_TAB_PROPERTY, canUseAjaxTabs()
  - canUseAjaxTabs
```
boolean canUseAjaxTabs()
```
    Returns true if history push state is supported by browser.
    
    Since:
    
    5.8
    
    See Also:
    
    useAjaxTabs()

Interface WebActions

Field Summary

Method Summary

Field Detail

NULL_TAB_ID

DEFAULT_TABS_CATEGORY

MAIN_TABS_CATEGORY

SUBTAB_CATEGORY_SUFFIX

DOCUMENTS_MAIN_TAB_ID

TAB_IDS_PARAMETER

MAIN_TAB_ID_PARAMETER

CURRENT_TAB_CHANGED_EVENT

CURRENT_TAB_SELECTED_EVENT

AJAX_TAB_PROPERTY

Method Detail

getDocumentActions

getDocumentAction

getActions

getAction

isAvailableForDocument

isAvailable

getActionsList

getActionsList

getActionsListForDocument

getActionsList

getActionsList

getAllActions

getTabsList

getSubTabsList

getCurrentTabAction

setCurrentTabAction

getCurrentSubTabAction

setCurrentSubTabAction

getCurrentTabId

setCurrentTabId

getCurrentSubTabId

setCurrentSubTabId

resetTabList

resetCurrentTab

getCurrentTabAction

getCurrentSubTabAction

setCurrentTabAction

getCurrentTabId

hasCurrentTabId

setCurrentTabId

getCurrentTabIds

setCurrentTabIds

resetCurrentTabs

resetCurrentTabs

setCurrentTabAndNavigate

setCurrentTabAndNavigate

checkFilter

getAction

getActionForDocument

getAction

useAjaxTabs

canUseAjaxTabs