org.nuxeo.ecm.webapp.action

Class MainTabsActions

java.lang.Object

org.nuxeo.ecm.webapp.action.MainTabsActions

All Implemented Interfaces:

Serializable

@Name(value="mainTabsActions")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class MainTabsActions
extends Object
implements Serializable

Handle Main tab related actions.

Maintains a Map of tab id -> contextual document.

Since:

5.4.2

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VIEW
static String	DOCUMENT_MANAGEMENT_ACTION Deprecated. since 5.5, use WebActions.DOCUMENTS_MAIN_TAB_ID instead
static String	MAIN_TAB_ID_PARAMETER Deprecated. since 5.5, use WebActions.MAIN_TAB_ID_PARAMETER instead
static String	MAIN_TABS_CATEGORY Deprecated. since 5.5, use WebActions.MAIN_TABS_CATEGORY instead
static String	TAB_IDS_PARAMETER Deprecated. since 5.5, use WebActions.TAB_IDS_PARAMETER instead

Constructor Summary

Constructors

Constructor and Description
MainTabsActions()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getDocumentFor(String mainTabId)
DocumentModel	getDocumentFor(String mainTabId, DocumentModel defaultDocument)
String	getPatternFor(String mainTabId)
String	getViewFor(Action mainTabAction)
String	getViewFor(String mainTabId)
boolean	isOnMainTab(String mainTabId)
void	setDocumentFor(String mainTabId, DocumentModel doc) Set the document used for a given mainTabId.
void	updateContextualDocument()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAIN_TABS_CATEGORY

@Deprecated
public static final String MAIN_TABS_CATEGORY

Deprecated. since 5.5, use WebActions.MAIN_TABS_CATEGORY instead

See Also:

Constant Field Values

DOCUMENT_MANAGEMENT_ACTION

@Deprecated
public static final String DOCUMENT_MANAGEMENT_ACTION

Deprecated. since 5.5, use WebActions.DOCUMENTS_MAIN_TAB_ID instead

See Also:

Constant Field Values

TAB_IDS_PARAMETER

@Deprecated
public static final String TAB_IDS_PARAMETER

Deprecated. since 5.5, use WebActions.TAB_IDS_PARAMETER instead

See Also:

Constant Field Values

MAIN_TAB_ID_PARAMETER

@Deprecated
public static final String MAIN_TAB_ID_PARAMETER

Deprecated. since 5.5, use WebActions.MAIN_TAB_ID_PARAMETER instead

See Also:

Constant Field Values

DEFAULT_VIEW

public static final String DEFAULT_VIEW

See Also:

Constant Field Values

Constructor Detail

MainTabsActions

public MainTabsActions()

Method Detail

updateContextualDocument

@Observer(value="navigateToDocument")
public void updateContextualDocument()

setDocumentFor

public void setDocumentFor(String mainTabId,
                  DocumentModel doc)

Set the document used for a given mainTabId.

Since:

5.7

getDocumentFor

public DocumentModel getDocumentFor(String mainTabId)
                             throws ClientException

Throws:

ClientException

getDocumentFor

public DocumentModel getDocumentFor(String mainTabId,
                           DocumentModel defaultDocument)
                             throws ClientException

Throws:

ClientException

getViewFor

public String getViewFor(Action mainTabAction)
                  throws ClientException

Throws:

ClientException

getViewFor

public String getViewFor(String mainTabId)
                  throws ClientException

Throws:

ClientException

getPatternFor

public String getPatternFor(String mainTabId)
                     throws ClientException

Throws:

ClientException

isOnMainTab

public boolean isOnMainTab(String mainTabId)