org.alfresco.web.bean.content

Class DocumentDetailsDialog

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.BaseDetailsBean

org.alfresco.web.bean.content.DocumentDetailsDialog

All Implemented Interfaces:

Serializable, IDialogBean, NavigationSupport

public class DocumentDetailsDialog
extends BaseDetailsBean
implements NavigationSupport

Backing bean providing access to the details of a document

Author:

gavinc

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckOutCheckInService	cociService
protected ContentFilterLanguagesService	contentFilterLanguagesService
protected EditionService	editionService
protected LockService	lockService
protected MultilingualContentService	multilingualContentService
protected VersionService	versionService

Fields inherited from class org.alfresco.web.bean.BaseDetailsBean

imageResolver, panels, template, workflowProperties

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
DocumentDetailsDialog() Default constructor

Method Summary

Modifier and Type	Method and Description
void	applyClassifiable() Applies the classifiable aspect to the current document
String	applyInlineEditable() Applies the inlineeditable aspect to the current document
void	applyVersionable() Applies the versionable aspect to the current document
String	cancel() Method handler called when the cancel button of the dialog is pressed
String	editContentProperties() Fixes an issue reported in https://issues.alfresco.com/jira/browse/ETWOONE-92
void	expandPanel(ActionEvent event) Save the state of the panel that was expanded/collapsed
protected String	finishImpl(FacesContext context, String outcome) Performs the actual processing for the wizard.
String	getBrowserUrl() Returns the URL to the content for the current document
String	getCancelButtonLabel() Returns the label to use for the cancel button
String	getCategoriesOverviewHTML() Returns a list of objects representing the categories applied to the current document
protected CheckOutCheckInService	getCheckOutCheckInService()
String	getContainerSubTitle() Returns the subtitle to be used for the dialog
String	getContainerTitle() Returns the title to be used for the dialog
protected ContentFilterLanguagesService	getContentFilterLanguagesService()
String	getCurrentItemId()
SingleEditionBean	getCurrentSingleEditionBean() For the client side iteration on the edition hitories list, return the current edition history.
Node	getDocument() Returns the document this bean is currently representing
Node	getDocumentMlContainer() Returns the ml container of the document this bean is currently representing
String	getDownloadUrl() Returns the download URL to the content for the current document
protected EditionService	getEditionService()
protected Node	getLinkResolvedNode() Resolve the actual document Node from any Link object that may be proxying it
protected LockService	getLockService()
protected MultilingualContentService	getMultilingualContentService()
SingleEditionBean	getNextSingleEditionBean() For the client side iteration on the edition hitories list, return the next edition history.
Node	getNode() Returns the Node this bean is currently representing
String	getOutcome()
protected String	getPropertiesPanelId()
Map	getTemplateModel() Returns a model for use by a template on the Document Details page.
Node	getTranslationDocument()
String	getUrl() Returns the URL to download content for the current document
List	getVersionHistory() Returns a list of objects representing the versions of the current document
protected VersionService	getVersionService()
Node	getWorkingCopyDocument()
void	init(Map<String,String> parameters) Initialises the dialog bean
boolean	isCategorised() Determines whether the current document has any categories applied
boolean	isInlineEditable()
boolean	isLocked() Returns whether the current document is locked
boolean	isMultilingual()
boolean	isOwner() Returns whether the current document is a working copy owned by the current User
boolean	isVersionable() Determines whether the current document is versionable
boolean	isWorkingCopy() Returns whether the current document is a working copy
void	nextItem(ActionEvent event) Navigates to next item in the list of content for the current Space
void	previousItem(ActionEvent event) Navigates to the previous item in the list of content for the current Space
void	reset() Resets any state that may be held by this bean
void	restored() Called when the dialog is restored after a nested dialog is closed
void	setCheckOutCheckInService(CheckOutCheckInService cociService) Sets the checkincheckout service instance the bean should use
void	setContentFilterLanguagesService(ContentFilterLanguagesService contentFilterLanguagesService)
void	setEditionService(EditionService editionService)
void	setLockService(LockService lockService) Sets the lock service instance the bean should use
void	setMultilingualContentService(MultilingualContentService multilingualContentService)
void	setTranslationDocument(Node node) Before opening the ml container details, remeber the translation from which the action comes.
void	setVersionService(VersionService versionService) Sets the version service instance the bean should use
void	unlock(ActionEvent event) Action Handler to unlock a locked document

Methods inherited from class org.alfresco.web.bean.BaseDetailsBean

applyTemplate, approve, cancelWorkflowEdit, getApproveStepName, getBookmarkUrl, getCifsPath, getCopyService, getHasCustomView, getHasTemplateView, getHasWebscriptView, getId, getName, getNodeRefUrl, getOwnableService, getPanels, getPermissionService, getRejectStepName, getTemplate, getTemplateRef, getWebdavUrl, getWebscriptUrl, getWorkflowProperties, reject, removeTemplate, saveWorkflow, setCopyService, setOwnableService, setPanels, setPermissionService, setTemplate, takeOwnership

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getContainerDescription, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getFinishButtonLabel, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, isFinished, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

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

Field Detail

lockService

protected transient LockService lockService

versionService

protected transient VersionService versionService

cociService

protected transient CheckOutCheckInService cociService

multilingualContentService

protected transient MultilingualContentService multilingualContentService

contentFilterLanguagesService

protected transient ContentFilterLanguagesService contentFilterLanguagesService

editionService

protected transient EditionService editionService

Constructor Detail

DocumentDetailsDialog

public DocumentDetailsDialog()

Default constructor

Method Detail

reset

public void reset()

Resets any state that may be held by this bean

init

public void init(Map<String,String> parameters)

Description copied from interface: IDialogBean

Initialises the dialog bean

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseDialogBean

Parameters:

parameters - Map of parameters for the dialog

restored

public void restored()

Description copied from interface: IDialogBean

Called when the dialog is restored after a nested dialog is closed

Specified by:

restored in interface IDialogBean

Overrides:

restored in class BaseDialogBean

cancel

public String cancel()

Description copied from interface: IDialogBean

Method handler called when the cancel button of the dialog is pressed

Specified by:

cancel in interface IDialogBean

Overrides:

cancel in class BaseDialogBean

Returns:

The outcome to return

getUrl

public String getUrl()

Returns the URL to download content for the current document

Returns:

Content url to download the current document

getTranslationDocument

public Node getTranslationDocument()

Returns:

the translation document for this node

setTranslationDocument

public void setTranslationDocument(Node node)

Before opening the ml container details, remeber the translation from which the action comes.

Parameters:

node -

getBrowserUrl

public String getBrowserUrl()

Returns the URL to the content for the current document

Returns:

Content url to the current document

getDownloadUrl

public String getDownloadUrl()

Returns the download URL to the content for the current document

Returns:

Download url to the current document

getLinkResolvedNode

protected Node getLinkResolvedNode()

Resolve the actual document Node from any Link object that may be proxying it

Specified by:

getLinkResolvedNode in class BaseDetailsBean

Returns:

current document Node or document Node resolved from any Link object

isVersionable

public boolean isVersionable()

Determines whether the current document is versionable

Returns:

true if the document has the versionable aspect

isInlineEditable

public boolean isInlineEditable()

Returns:

true if the current document has the 'inlineeditable' aspect applied

isMultilingual

public boolean isMultilingual()

Returns:

true if the current document has the 'inlineeditable' aspect applied

editContentProperties

public String editContentProperties()

Fixes an issue reported in https://issues.alfresco.com/jira/browse/ETWOONE-92

Returns:

Returns action

expandPanel

public void expandPanel(ActionEvent event)

Save the state of the panel that was expanded/collapsed

Overrides:

expandPanel in class BaseDetailsBean

getVersionHistory

public List getVersionHistory()

Returns a list of objects representing the versions of the current document

Returns:

List of previous versions

getNextSingleEditionBean

public SingleEditionBean getNextSingleEditionBean()

For the client side iteration on the edition hitories list, return the next edition history.

Returns:

a light weight representation of an edition history

getCurrentSingleEditionBean

public SingleEditionBean getCurrentSingleEditionBean()

For the client side iteration on the edition hitories list, return the current edition history.

Returns:

a light weight representation of an edition history

isCategorised

public boolean isCategorised()

Determines whether the current document has any categories applied

Returns:

true if the document has categories attached

getCategoriesOverviewHTML

public String getCategoriesOverviewHTML()

Returns a list of objects representing the categories applied to the current document

Returns:

List of categories

applyClassifiable

public void applyClassifiable()

Applies the classifiable aspect to the current document

applyVersionable

public void applyVersionable()

Applies the versionable aspect to the current document

unlock

public void unlock(ActionEvent event)

Action Handler to unlock a locked document

applyInlineEditable

public String applyInlineEditable()

Applies the inlineeditable aspect to the current document

nextItem

public void nextItem(ActionEvent event)

Navigates to next item in the list of content for the current Space

Specified by:

nextItem in interface NavigationSupport

previousItem

public void previousItem(ActionEvent event)

Navigates to the previous item in the list of content for the current Space

Specified by:

previousItem in interface NavigationSupport

getPropertiesPanelId

protected String getPropertiesPanelId()

Specified by:

getPropertiesPanelId in class BaseDetailsBean

Returns:

id of the properties panel component

See Also:

BaseDetailsBean.getPropertiesPanelId()

getTemplateModel

public Map getTemplateModel()

Returns a model for use by a template on the Document Details page.

Specified by:

getTemplateModel in class BaseDetailsBean

Returns:

model containing current document and current space info.

isLocked

public boolean isLocked()

Returns whether the current document is locked

Returns:

true if the document is checked out

isWorkingCopy

public boolean isWorkingCopy()

Returns whether the current document is a working copy

Returns:

true if the document is a working copy

getWorkingCopyDocument

public Node getWorkingCopyDocument()

Returns:

the working copy document Node for this document if found and the current has permission or null if not

isOwner

public boolean isOwner()

Returns whether the current document is a working copy owned by the current User

Returns:

true if the document is a working copy owner by the current User

getNode

public Node getNode()

Returns the Node this bean is currently representing

Specified by:

getNode in class BaseDetailsBean

Returns:

The Node

getDocument

public Node getDocument()

Returns the document this bean is currently representing

Returns:

The document Node

getDocumentMlContainer

public Node getDocumentMlContainer()

Returns the ml container of the document this bean is currently representing

Returns:

The document multilingual container NodeRef

setLockService

public void setLockService(LockService lockService)

Sets the lock service instance the bean should use

Parameters:

lockService - The LockService

getLockService

protected LockService getLockService()

setVersionService

public void setVersionService(VersionService versionService)

Sets the version service instance the bean should use

Parameters:

versionService - The VersionService

getVersionService

protected VersionService getVersionService()

setCheckOutCheckInService

public void setCheckOutCheckInService(CheckOutCheckInService cociService)

Sets the checkincheckout service instance the bean should use

Parameters:

cociService - The CheckOutCheckInService

getCheckOutCheckInService

protected CheckOutCheckInService getCheckOutCheckInService()

Overrides:

getCheckOutCheckInService in class BaseDialogBean

setMultilingualContentService

public void setMultilingualContentService(MultilingualContentService multilingualContentService)

Parameters:

multilingualContentService - the multilingual ContentService to set

getMultilingualContentService

protected MultilingualContentService getMultilingualContentService()

setContentFilterLanguagesService

public void setContentFilterLanguagesService(ContentFilterLanguagesService contentFilterLanguagesService)

Parameters:

contentFilterLanguagesService - The Content Filter Languages Service to set.

getContentFilterLanguagesService

protected ContentFilterLanguagesService getContentFilterLanguagesService()

setEditionService

public void setEditionService(EditionService editionService)

Parameters:

editionService - The Edition Service to set.

getEditionService

protected EditionService getEditionService()

getCancelButtonLabel

public String getCancelButtonLabel()

Description copied from interface: IDialogBean

Returns the label to use for the cancel button

Specified by:

getCancelButtonLabel in interface IDialogBean

Overrides:

getCancelButtonLabel in class BaseDialogBean

Returns:

The cancel button label

getContainerSubTitle

public String getContainerSubTitle()

Description copied from interface: IDialogBean

Returns the subtitle to be used for the dialog

If this returns null the DialogManager will lookup the subtitle via the dialog configuration

Specified by:

getContainerSubTitle in interface IDialogBean

Overrides:

getContainerSubTitle in class BaseDialogBean

Returns:

The subtitle or null if the subtitle is to be acquired via configuration

getContainerTitle

public String getContainerTitle()

Description copied from interface: IDialogBean

Returns the title to be used for the dialog

If this returns null the DialogManager will lookup the title via the dialog configuration

Specified by:

getContainerTitle in interface IDialogBean

Overrides:

getContainerTitle in class BaseDialogBean

Returns:

The title or null if the title is to be acquired via configuration

getCurrentItemId

public String getCurrentItemId()

Specified by:

getCurrentItemId in interface NavigationSupport

finishImpl

protected String finishImpl(FacesContext context,
                            String outcome)
                     throws Exception

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Exception

getOutcome

public String getOutcome()

Specified by:

getOutcome in interface NavigationSupport