org.alfresco.web.bean.coci
Class CheckinCheckoutDialog

java.lang.Object
  extended by org.alfresco.web.bean.dialog.BaseDialogBean
      extended by org.alfresco.web.bean.coci.CheckinCheckoutDialog
All Implemented Interfaces:
java.io.Serializable, IDialogBean
Direct Known Subclasses:
CancelEditingDialog, CCCheckinFileDialog, CCCheckoutFileDialog, CCCheckoutFileLinkDialog, CCEditFileDialog, CCEditHtmlInlineDialog, CCEditTextInlineDialog, CCUndoCheckoutFileDialog, CCUpdateFileDialog, CCWorkingCopyMissingDialog, DoneEditingDialog, EditOfflineDialog

public class CheckinCheckoutDialog
extends BaseDialogBean

See Also:
Serialized Form

Field Summary
static java.lang.String FILE
           
static java.lang.String MSG_ERROR_CANCELCHECKOUT
           
static java.lang.String MSG_ERROR_CHECKIN
           
static java.lang.String MSG_ERROR_CHECKOUT
           
static java.lang.String MSG_ERROR_UPDATE
           
protected  CCProperties property
           
 
Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean
browseBean, isFinished, navigator, parameters
 
Constructor Summary
CheckinCheckoutDialog()
           
 
Method Summary
 java.lang.String cancel()
          Deals with the cancel button being pressed on the check in file page
 java.lang.String checkinFileOK(javax.faces.context.FacesContext context, java.lang.String outcome)
          Action called upon completion of the Check In file page
protected  void clearUpload(java.lang.String id)
          Clear the uploaded form, clearing the specific Upload component by Id
 void editFile(javax.faces.event.ActionEvent event)
          Action handler called to calculate which editing screen to display based on the mimetype of a document.
 java.lang.String editInline(javax.faces.context.FacesContext context, java.lang.String outcome)
          Action handler called to set the content of a node from an inline editing page.
protected  java.lang.String finishImpl(javax.faces.context.FacesContext context, java.lang.String outcome)
          Performs the actual processing for the wizard.
 BrowseBean getBrowseBean()
           
 java.lang.String getContainerTitle()
          Returns the title to be used for the dialog
 java.lang.String getFileName()
           
 java.lang.String getFileUploadSuccessMsg()
           
 boolean getFinishButtonDisabled()
          Determines whether the finish button on the dialog should be disabled
 java.lang.String getFinishButtonLabel()
          Returns the label to use for the finish button
 boolean isVersionable()
          Determines whether the document being checked in has the versionable aspect applied
 java.lang.String removeUploadedFile()
          Action handler called when the user wishes to remove an uploaded file
 void resetState()
          Clear form state and upload file bean
 void setBrowseBean(BrowseBean browseBean)
           
 void setFileName(java.lang.String fileName)
           
 void setNavigator(NavigationBean navigator)
           
 void setProperty(CCProperties property)
           
 void setupContentAction(javax.faces.event.ActionEvent event)
          Action event called by all actions that need to setup a Content Document context on the CheckinCheckoutDialog before an action page/wizard is called.
protected  Node setupContentDocument(java.lang.String id)
          Setup a content document node context
 void setupWorkflowContentAction(javax.faces.event.ActionEvent event)
           
 java.lang.String undoCheckout()
          Action to undo the checkout of a document just checked out from the checkout screen.
 java.lang.String updateFileOK(javax.faces.context.FacesContext context, java.lang.String outcome)
          Action called upon completion of the Update File page
 
Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean
doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, init, isFinished, restored, setDictionaryService, setFileFolderService, setNamespaceService, setNodeService, setSearchService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MSG_ERROR_CHECKIN

public static final java.lang.String MSG_ERROR_CHECKIN
See Also:
Constant Field Values

MSG_ERROR_CANCELCHECKOUT

public static final java.lang.String MSG_ERROR_CANCELCHECKOUT
See Also:
Constant Field Values

MSG_ERROR_UPDATE

public static final java.lang.String MSG_ERROR_UPDATE
See Also:
Constant Field Values

MSG_ERROR_CHECKOUT

public static final java.lang.String MSG_ERROR_CHECKOUT
See Also:
Constant Field Values

FILE

public static final java.lang.String FILE
See Also:
Constant Field Values

property

protected CCProperties property
Constructor Detail

CheckinCheckoutDialog

public CheckinCheckoutDialog()
Method Detail

setProperty

public void setProperty(CCProperties property)
Parameters:
property - the property to set

setNavigator

public void setNavigator(NavigationBean navigator)
Overrides:
setNavigator in class BaseDialogBean
Parameters:
navigator - The NavigationBean to set.

getBrowseBean

public BrowseBean getBrowseBean()
Returns:
Returns the BrowseBean.

setBrowseBean

public void setBrowseBean(BrowseBean browseBean)
Overrides:
setBrowseBean in class BaseDialogBean
Parameters:
browseBean - The BrowseBean to set.

getFinishButtonDisabled

public boolean getFinishButtonDisabled()
Description copied from interface: IDialogBean
Determines whether the finish button on the dialog should be disabled

Specified by:
getFinishButtonDisabled in interface IDialogBean
Overrides:
getFinishButtonDisabled in class BaseDialogBean
Returns:
true if the button should be disabled

getFinishButtonLabel

public java.lang.String getFinishButtonLabel()
Description copied from interface: IDialogBean
Returns the label to use for the finish button

Specified by:
getFinishButtonLabel in interface IDialogBean
Overrides:
getFinishButtonLabel in class BaseDialogBean
Returns:
The finish button label

getContainerTitle

public java.lang.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

isVersionable

public boolean isVersionable()
Determines whether the document being checked in has the versionable aspect applied

Returns:
true if the versionable aspect is applied

getFileUploadSuccessMsg

public java.lang.String getFileUploadSuccessMsg()
Returns:
Returns the message to display when a file has been uploaded

getFileName

public java.lang.String getFileName()
Returns:
Returns the name of the file

setFileName

public void setFileName(java.lang.String fileName)
Parameters:
fileName - The name of the file

clearUpload

protected void clearUpload(java.lang.String id)
Clear the uploaded form, clearing the specific Upload component by Id


removeUploadedFile

public java.lang.String removeUploadedFile()
Action handler called when the user wishes to remove an uploaded file


setupContentAction

public void setupContentAction(javax.faces.event.ActionEvent event)
Action event called by all actions that need to setup a Content Document context on the CheckinCheckoutDialog before an action page/wizard is called. The context will be a Node in setDocument() which can be retrieved on action pages via getDocument().

Parameters:
event - ActionEvent

setupWorkflowContentAction

public void setupWorkflowContentAction(javax.faces.event.ActionEvent event)

setupContentDocument

protected Node setupContentDocument(java.lang.String id)
Setup a content document node context

Parameters:
id - GUID of the node to setup as the content document context
Returns:
The Node

editFile

public void editFile(javax.faces.event.ActionEvent event)
Action handler called to calculate which editing screen to display based on the mimetype of a document. If appropriate, the in-line editing screen will be shown.


editInline

public java.lang.String editInline(javax.faces.context.FacesContext context,
                                   java.lang.String outcome)
Action handler called to set the content of a node from an inline editing page.


undoCheckout

public java.lang.String undoCheckout()
Action to undo the checkout of a document just checked out from the checkout screen.


checkinFileOK

public java.lang.String checkinFileOK(javax.faces.context.FacesContext context,
                                      java.lang.String outcome)
Action called upon completion of the Check In file page


updateFileOK

public java.lang.String updateFileOK(javax.faces.context.FacesContext context,
                                     java.lang.String outcome)
Action called upon completion of the Update File page


cancel

public java.lang.String cancel()
Deals with the cancel button being pressed on the check in file page

Specified by:
cancel in interface IDialogBean
Overrides:
cancel in class BaseDialogBean
Returns:
The outcome to return

finishImpl

protected java.lang.String finishImpl(javax.faces.context.FacesContext context,
                                      java.lang.String outcome)
                               throws java.lang.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:
java.lang.Exception

resetState

public void resetState()
Clear form state and upload file bean



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.