com.wewebu.ow.server.plug.owdocprops
Class OwEditPropertiesDialog

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwView
          extended by com.wewebu.ow.server.ui.OwLayout
              extended by com.wewebu.ow.server.ui.OwDialog
                  extended by com.wewebu.ow.server.app.OwStandardDialog
                      extended by com.wewebu.ow.server.app.OwStandardSequenceDialog
                          extended by com.wewebu.ow.server.plug.owdocprops.OwEditPropertiesDialog
All Implemented Interfaces:
com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.app.OwSequenceView, com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwJspConfigurable, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwEditPropertiesDialog
extends com.wewebu.ow.server.app.OwStandardSequenceDialog
implements com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner, com.wewebu.ow.server.ui.OwJspConfigurable

Implementation of the Document edit properties Dialog.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Nested Class Summary
 
Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwDialog
com.wewebu.ow.server.ui.OwDialog.OwDialogListener
 
Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout
com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion
 
Field Summary
protected  Collection m_batchIndexProperties
          property set that holds the batch properties, which will be prefilled from previous screens
protected  List m_DocumentFunctionPluginList
          list of Document function plugins which have been instantiated
protected  Collection m_historyViewColumnInfo
          column info for the history view
protected  com.wewebu.ow.server.field.OwSearchTemplate m_historyViewSearchTemplate
          OwSearchTemplate to filter the history view
protected  int m_iIndex
          current item index
protected  int m_iMaxElementSize
          max number of items to display in the views
protected  int m_iReadOnlyViewMask
          filters the views to be displayed read-only
protected  List m_items
          list of items to work on
protected  int m_iViewMask
          filters the views to be displayed
protected  com.wewebu.ow.server.app.OwMimeManager m_MimeManager
          instance of the MIME manager used to open the objects
protected  com.wewebu.ow.server.ecm.OwObject m_ParentObject
          the parent of the object that listed the getItem()
protected  com.wewebu.ow.server.app.OwSubNavigationView m_SubNavigation
          navigation view to navigate through the subviews
protected  Collection m_VersionColumnInfo
          list of column info for the version view
protected static String PLUG_INDEX_KEY
          query string key for the plugin index.
static int VIEW_MASK_ACCESS_RIGHTS
          mask value for the access rights view
static int VIEW_MASK_AUTOOPEN
          mask value to use auto open object
static int VIEW_MASK_DOCUMENT_FUNCTIONS
          mask value for the document functions menu view
static int VIEW_MASK_ENABLE_PASTE_METADATA
          mask value to enable paste metadata in property view
static int VIEW_MASK_ENABLE_SAVE_ALL
          mask value for the save all button
static int VIEW_MASK_FILED_IN
          mask value for the filed in view
static int VIEW_MASK_HISTORY
          mask value for the history view
static int VIEW_MASK_HISTORY_SCOPE_CASE
          mask value for the history view, enable case (bpm) history
static int VIEW_MASK_HISTORY_SCOPE_OBJECT
          mask value for the history view, enable object history
static int VIEW_MASK_LINKS
          mask value for the links view
static int VIEW_MASK_PREVIEW_AUTOOPEN
          mask value to use preview mode for auto open
static int VIEW_MASK_PROPERTIES
          mask value for the properties view
static int VIEW_MASK_SYSTEM_PROPERTIES
          mask value for the system properties view
static int VIEW_MASK_VERSIONS
          mask value for the versions view
 
Fields inherited from class com.wewebu.ow.server.app.OwStandardDialog
CLOSE_BTN_REGION, FOOTER_REGION, HELP_BTN_REGION, INFO_ICON_REGION, LEFT_REGION, m_strHelpPath, m_strInfoIconURL, m_strTitle, MAIN_REGION, MENU_REGION, RIGHT_REGION, STANDARD_DIALOG_REGION_MAX, TITLE_REGION
 
Fields inherited from class com.wewebu.ow.server.ui.OwDialog
m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener
 
Fields inherited from class com.wewebu.ow.server.ui.OwLayout
m_Regions
 
Fields inherited from class com.wewebu.ow.server.ui.OwView
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
 
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView
EMPTY_STRING
 
Constructor Summary
  OwEditPropertiesDialog(Collection objects_p, int iIndex_p, com.wewebu.ow.server.ecm.OwObject parentObject_p, int iMaxElementSize_p, Collection versionColumnInfo_p, com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p, Collection historyViewColumnInfo_p, Collection batchIndexProperties_p)
          Deprecated. since 4.1.1.0 use OwEditPropertiesDialogBuilder
protected OwEditPropertiesDialog(OwEditPropertiesDialogBuilder builder)
           
  OwEditPropertiesDialog(com.wewebu.ow.server.ecm.OwObject obj_p, com.wewebu.ow.server.ecm.OwObject parentObject_p, int iMaxElementSize_p, Collection versionColumnInfo_p, com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p, Collection historyViewColumnInfo_p)
          Deprecated. since 4.1.1.0 use OwEditPropertiesDialogBuilder
 
Method Summary
protected  void addExtraMenuButtons(com.wewebu.ow.server.dmsdialogs.OwPropertyViewBridge propertyViewBridge_p)
          Add extra buttons (Save+next, Save+close, Save all) to the properties view.
 void closeDialog()
          visually close the Dialog.
 boolean closeDlgWOSaving()
          Should dialog be closed, even if save was not executed.
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectAccessRightsView createAccessRightsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the access rights view
protected  OwEditPropertiesDialog createEditPropertiesDialog()
          overridable to create a new dialog when browsing through multiple objects
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectEditVersionsView createEditVersionsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the edit versions view
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectFiledRecordsView createFiledRecordsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the filed records view
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyFormularView createFormPropertyView(com.wewebu.ow.server.app.OwSubNavigationView subNavigation_p, com.wewebu.ow.server.ecm.OwObject object_p)
          Create the view based on JSP form for rendering properties.
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectHistoryView createHistoryView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the history view
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectLinksView createLinksView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the edit links view
protected  com.wewebu.ow.server.app.OwMimeManager createMimeManager()
          (overridable) Factory method to create a OwMimeManger to be used by this instance.
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createPropertyView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the property view
protected  com.wewebu.ow.server.dmsdialogs.OwPropertyViewBridge createPropertyViewBridge(com.wewebu.ow.server.app.OwSubNavigationView subNavigation_p, com.wewebu.ow.server.ecm.OwObject item_p)
          Create OwPropertyViewBridge object.
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createPropertyViewInstance()
          Create property view instance
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createSystemPropertyView(com.wewebu.ow.server.app.OwSubNavigationView nav_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          overridable factory method to create and init the system property view
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createSystemPropertyViewInstance()
          Create system property view instance
 void detach()
          remove view and all subviews from context
 boolean displayNoSaveMsg()
          Display "no save" message.
 int getCount()
          get the number of sequence items in the dialog
protected  com.wewebu.ow.server.dmsdialogs.OwGroupPropertiesConfiguration getGroupPropertiesConfiguration()
          Get the current configuration for grouping of properties.
 com.wewebu.ow.server.ecm.OwObject getItem()
          the work item to work on
 com.wewebu.ow.server.app.OwJspFormConfigurator getJspConfigurator()
           
 String getLatestVersionURL()
          get the event URL for the latest version button
 com.wewebu.ow.server.app.OwMimeManager getMimeManager()
          get the MIME manager
 String getReleasedVersionURL()
          get the event URL for the released version button
 boolean hasNext()
          called when the Dialog needs to know if there is a next item
 boolean hasPrev()
          called when the Dialog needs to know if there is a prev item
protected  boolean hasReadOnlyViewMask(int iViewMask_p)
          check if view should be displayed read-only
protected  boolean hasViewMask(int iViewMask_p)
          check if view should be displayed or is masked out
protected  void init()
          init the target after the context is set.
protected  void initNewItem(boolean fBatchIndex_p)
          init the dialog with the current item
 boolean isRegion(int iRegion_p)
          determine if region contains a view
 void next(boolean fRemoveCurrent_p)
          move to next item and roll over, i.e.
 boolean onCancel(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          event called when user clicked Cancel button in the menu of the property view
 void onClientRefreshContextUpdate(int iReason_p, Object param_p)
          implementation of the OwFunction.OwFunctionRefreshContext interface Called from a plugin to inform its client and cause refresh of display data
 void onLatestVersion(javax.servlet.http.HttpServletRequest request_p)
          called when user pressed get Latest Version
 void onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p, com.wewebu.ow.server.ecm.OwObject parent_p)
           
 String onObjectListViewGetRowClassName(int iIndex_p, com.wewebu.ow.server.ecm.OwObject obj_p)
          get the style class name for the row
 boolean onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p)
          called when uses clicks on a folder, used to redirect folder events an bypass the mimemanager
 void onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p, com.wewebu.ow.server.ecm.OwObject parent_p)
          called when user clicks a select button, fUseSelectButton_p must have been set to display select buttons
 void onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p, String strSortProperty_p)
          called when uses clicks on a sort header and the sort changes
 void onPluginEvent(javax.servlet.http.HttpServletRequest request_p)
          event called when user clicked on a plugin link of an object entry in the list
 boolean onPropertiesNext(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          Method handler used when user press the button "Save + next"
 boolean onPropertiesSaveAll(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          event called when user clicked SaveAll button in the menu of the property view
 boolean onPropertiesSavePlusClose(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          Method handler used when user press the button "Save + close"
 boolean onPropertiesSavePlusNext(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          Method handler used when user press the button "Save + next"
 void onReleasedVersion(javax.servlet.http.HttpServletRequest request_p)
          called when user pressed get Released Version
 void prev(boolean fRemoveCurrent_p)
          move to prev item and roll over, i.e.
 void renderRegion(Writer w_p, int iRegion_p)
          render the views of the region
 void setCloseDlgWOSaving(boolean closeDlg_p)
          Set the flag if the Dialog should be closed if no save was executed.
 void setDisplayNoSaveMsg(boolean display_p)
          Set the flag if "no save" message(s) should be displayed or not.
 void setGroupPropertiesConfiguration(com.wewebu.ow.server.dmsdialogs.OwGroupPropertiesConfiguration groupPropertyConfiguration_p)
          Set the configuration for grouped properties.
 void setJspConfigurator(com.wewebu.ow.server.app.OwJspFormConfigurator jspFormConfigurator_p)
           
 void setReadOnlyViewMask(int iViewMask_p)
          determine the views to be displayed read-only by masking them with their flag
 void setViewMask(int iViewMask_p)
          determine the views to be displayed by masking them with their flag
 boolean showPluginOnItem(com.wewebu.ow.server.app.OwDocumentFunction plugin_p)
          check if plugin displays in context menu rather than directly has an object instance, i.e.
 
Methods inherited from class com.wewebu.ow.server.app.OwStandardSequenceDialog
onNext, onPrev, renderNavigationButtons
 
Methods inherited from class com.wewebu.ow.server.app.OwStandardDialog
getInfoIcon, getTitle, hasHelpButton, onClose, onHelp, onRender, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle
 
Methods inherited from class com.wewebu.ow.server.ui.OwDialog
setListener
 
Methods inherited from class com.wewebu.ow.server.ui.OwLayout
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
 
Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PLUG_INDEX_KEY

protected static final String PLUG_INDEX_KEY
query string key for the plugin index.

See Also:
Constant Field Values

VIEW_MASK_PROPERTIES

public static final int VIEW_MASK_PROPERTIES
mask value for the properties view

See Also:
Constant Field Values

VIEW_MASK_SYSTEM_PROPERTIES

public static final int VIEW_MASK_SYSTEM_PROPERTIES
mask value for the system properties view

See Also:
Constant Field Values

VIEW_MASK_ACCESS_RIGHTS

public static final int VIEW_MASK_ACCESS_RIGHTS
mask value for the access rights view

See Also:
Constant Field Values

VIEW_MASK_VERSIONS

public static final int VIEW_MASK_VERSIONS
mask value for the versions view

See Also:
Constant Field Values

VIEW_MASK_HISTORY

public static final int VIEW_MASK_HISTORY
mask value for the history view

See Also:
Constant Field Values

VIEW_MASK_FILED_IN

public static final int VIEW_MASK_FILED_IN
mask value for the filed in view

See Also:
Constant Field Values

VIEW_MASK_DOCUMENT_FUNCTIONS

public static final int VIEW_MASK_DOCUMENT_FUNCTIONS
mask value for the document functions menu view

See Also:
Constant Field Values

VIEW_MASK_ENABLE_PASTE_METADATA

public static final int VIEW_MASK_ENABLE_PASTE_METADATA
mask value to enable paste metadata in property view

See Also:
Constant Field Values

VIEW_MASK_PREVIEW_AUTOOPEN

public static final int VIEW_MASK_PREVIEW_AUTOOPEN
mask value to use preview mode for auto open

See Also:
Constant Field Values

VIEW_MASK_AUTOOPEN

public static final int VIEW_MASK_AUTOOPEN
mask value to use auto open object

See Also:
Constant Field Values

VIEW_MASK_HISTORY_SCOPE_OBJECT

public static final int VIEW_MASK_HISTORY_SCOPE_OBJECT
mask value for the history view, enable object history

See Also:
Constant Field Values

VIEW_MASK_HISTORY_SCOPE_CASE

public static final int VIEW_MASK_HISTORY_SCOPE_CASE
mask value for the history view, enable case (bpm) history

See Also:
Constant Field Values

VIEW_MASK_ENABLE_SAVE_ALL

public static final int VIEW_MASK_ENABLE_SAVE_ALL
mask value for the save all button

See Also:
Constant Field Values

VIEW_MASK_LINKS

public static int VIEW_MASK_LINKS
mask value for the links view


m_iViewMask

protected int m_iViewMask
filters the views to be displayed


m_iReadOnlyViewMask

protected int m_iReadOnlyViewMask
filters the views to be displayed read-only


m_DocumentFunctionPluginList

protected List m_DocumentFunctionPluginList
list of Document function plugins which have been instantiated


m_SubNavigation

protected com.wewebu.ow.server.app.OwSubNavigationView m_SubNavigation
navigation view to navigate through the subviews


m_MimeManager

protected com.wewebu.ow.server.app.OwMimeManager m_MimeManager
instance of the MIME manager used to open the objects


m_ParentObject

protected com.wewebu.ow.server.ecm.OwObject m_ParentObject
the parent of the object that listed the getItem()


m_VersionColumnInfo

protected Collection m_VersionColumnInfo
list of column info for the version view


m_historyViewSearchTemplate

protected com.wewebu.ow.server.field.OwSearchTemplate m_historyViewSearchTemplate
OwSearchTemplate to filter the history view


m_historyViewColumnInfo

protected Collection m_historyViewColumnInfo
column info for the history view


m_iMaxElementSize

protected int m_iMaxElementSize
max number of items to display in the views


m_batchIndexProperties

protected Collection m_batchIndexProperties
property set that holds the batch properties, which will be prefilled from previous screens


m_items

protected List m_items
list of items to work on


m_iIndex

protected int m_iIndex
current item index

Constructor Detail

OwEditPropertiesDialog

protected OwEditPropertiesDialog(OwEditPropertiesDialogBuilder builder)

OwEditPropertiesDialog

public OwEditPropertiesDialog(com.wewebu.ow.server.ecm.OwObject obj_p,
                              com.wewebu.ow.server.ecm.OwObject parentObject_p,
                              int iMaxElementSize_p,
                              Collection versionColumnInfo_p,
                              com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p,
                              Collection historyViewColumnInfo_p)
                       throws Exception
Deprecated. since 4.1.1.0 use OwEditPropertiesDialogBuilder

set the object, the edit properties view is working on

Parameters:
obj_p - OwObject
parentObject_p - the parent OwObject of the object that listed the getItem()
iMaxElementSize_p - max number of version to display
versionColumnInfo_p - list of Property Names to act as columns
historyViewSearchTemplate_p - OwSearchTemplate to filter the history view
historyViewColumnInfo_p - list of Property Names to act as columns
Throws:
Exception

OwEditPropertiesDialog

public OwEditPropertiesDialog(Collection objects_p,
                              int iIndex_p,
                              com.wewebu.ow.server.ecm.OwObject parentObject_p,
                              int iMaxElementSize_p,
                              Collection versionColumnInfo_p,
                              com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p,
                              Collection historyViewColumnInfo_p,
                              Collection batchIndexProperties_p)
                       throws Exception
Deprecated. since 4.1.1.0 use OwEditPropertiesDialogBuilder

set the object, the edit properties view is working on

Parameters:
objects_p - List of OwObject
iIndex_p - int index in objects_p to work on, usually 0
parentObject_p - the parent OwObject of the object that listed the getItem()
iMaxElementSize_p - max number of version to display
versionColumnInfo_p - list of Property Names to act as columns
historyViewSearchTemplate_p - OwSearchTemplate to filter the history view
historyViewColumnInfo_p - list of Property Names to act as columns
batchIndexProperties_p - Collection of batch index properties each property will be copied to the next pane
Throws:
Exception
Method Detail

setViewMask

public void setViewMask(int iViewMask_p)
determine the views to be displayed by masking them with their flag

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

setReadOnlyViewMask

public void setReadOnlyViewMask(int iViewMask_p)
determine the views to be displayed read-only by masking them with their flag

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

hasViewMask

protected boolean hasViewMask(int iViewMask_p)
check if view should be displayed or is masked out

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

hasReadOnlyViewMask

protected boolean hasReadOnlyViewMask(int iViewMask_p)
check if view should be displayed read-only

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

init

protected void init()
             throws Exception
init the target after the context is set.

Overrides:
init in class com.wewebu.ow.server.ui.OwView
Throws:
Exception

createPropertyViewBridge

protected com.wewebu.ow.server.dmsdialogs.OwPropertyViewBridge createPropertyViewBridge(com.wewebu.ow.server.app.OwSubNavigationView subNavigation_p,
                                                                                        com.wewebu.ow.server.ecm.OwObject item_p)
                                                                                 throws Exception
Create OwPropertyViewBridge object.

Parameters:
subNavigation_p - - the navigation view.
item_p - - the OwObject
Returns:
the newly created OwPropertyViewBridge object
Throws:
Exception
Since:
3.1.0.0

createFormPropertyView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyFormularView createFormPropertyView(com.wewebu.ow.server.app.OwSubNavigationView subNavigation_p,
                                                                                                    com.wewebu.ow.server.ecm.OwObject object_p)
                                                                                             throws Exception
Create the view based on JSP form for rendering properties.

Parameters:
subNavigation_p - - the navigation view
object_p - - the OwObject object.
Returns:
- the newly created OwObjectPropertyFormularView object
Throws:
Exception
Since:
3.1.0.0

detach

public void detach()
remove view and all subviews from context

Overrides:
detach in class com.wewebu.ow.server.ui.OwView

isRegion

public boolean isRegion(int iRegion_p)
determine if region contains a view

Specified by:
isRegion in interface com.wewebu.ow.server.ui.OwBaseView
Overrides:
isRegion in class com.wewebu.ow.server.app.OwStandardDialog
Parameters:
iRegion_p - ID of the region to render
Returns:
true if region contains anything and should be rendered

getMimeManager

public com.wewebu.ow.server.app.OwMimeManager getMimeManager()
get the MIME manager

Returns:
OwMimeManager

getLatestVersionURL

public String getLatestVersionURL()
get the event URL for the latest version button

Returns:
String

getReleasedVersionURL

public String getReleasedVersionURL()
get the event URL for the released version button

Returns:
String

onLatestVersion

public void onLatestVersion(javax.servlet.http.HttpServletRequest request_p)
                     throws Exception
called when user pressed get Latest Version

Throws:
Exception

onReleasedVersion

public void onReleasedVersion(javax.servlet.http.HttpServletRequest request_p)
                       throws Exception
called when user pressed get Released Version

Throws:
Exception

showPluginOnItem

public boolean showPluginOnItem(com.wewebu.ow.server.app.OwDocumentFunction plugin_p)
check if plugin displays in context menu rather than directly has an object instance, i.e. is displayed for each item.

Parameters:
plugin_p - OwDocumentFunction
Returns:
boolean

renderRegion

public void renderRegion(Writer w_p,
                         int iRegion_p)
                  throws Exception
render the views of the region

Specified by:
renderRegion in interface com.wewebu.ow.server.ui.OwBaseView
Overrides:
renderRegion in class com.wewebu.ow.server.app.OwStandardSequenceDialog
Parameters:
w_p - Writer object to write HTML to
iRegion_p - ID of the region to render
Throws:
Exception

onPluginEvent

public void onPluginEvent(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception
event called when user clicked on a plugin link of an object entry in the list

Parameters:
request_p - a HttpServletRequest
Throws:
Exception

onClientRefreshContextUpdate

public void onClientRefreshContextUpdate(int iReason_p,
                                         Object param_p)
                                  throws Exception
implementation of the OwFunction.OwFunctionRefreshContext interface Called from a plugin to inform its client and cause refresh of display data

Specified by:
onClientRefreshContextUpdate in interface com.wewebu.ow.server.app.OwClientRefreshContext
Parameters:
iReason_p - reason as defined with OwFunction.REFRESH_...
param_p - Object optional parameter representing the refresh, depends on the value of iReason_p, can be null
Throws:
Exception

onObjectListViewSelect

public void onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p,
                                   com.wewebu.ow.server.ecm.OwObject parent_p)
                            throws Exception
called when user clicks a select button, fUseSelectButton_p must have been set to display select buttons

Specified by:
onObjectListViewSelect in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Parameters:
object_p - OwObject object that was selected
parent_p - OwObject parent if available, or null
Throws:
Exception

onObjectListViewSort

public void onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p,
                                 String strSortProperty_p)
                          throws Exception
called when uses clicks on a sort header and the sort changes

Specified by:
onObjectListViewSort in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Parameters:
newSort_p - OwSort new sort
strSortProperty_p - String Property Name of sort property that was changed
Throws:
Exception

createEditPropertiesDialog

protected OwEditPropertiesDialog createEditPropertiesDialog()
                                                     throws Exception
overridable to create a new dialog when browsing through multiple objects

Returns:
OwEditPropertiesDialog
Throws:
Exception

initNewItem

protected void initNewItem(boolean fBatchIndex_p)
                    throws Exception
init the dialog with the current item

Parameters:
fBatchIndex_p - true = index the properties with previous ones
Throws:
Exception

getItem

public com.wewebu.ow.server.ecm.OwObject getItem()
the work item to work on


hasNext

public boolean hasNext()
                throws Exception
called when the Dialog needs to know if there is a next item

Specified by:
hasNext in interface com.wewebu.ow.server.app.OwSequenceView
Overrides:
hasNext in class com.wewebu.ow.server.app.OwStandardSequenceDialog
Throws:
Exception

hasPrev

public boolean hasPrev()
                throws Exception
called when the Dialog needs to know if there is a prev item

Specified by:
hasPrev in interface com.wewebu.ow.server.app.OwSequenceView
Overrides:
hasPrev in class com.wewebu.ow.server.app.OwStandardSequenceDialog
Throws:
Exception

getCount

public int getCount()
get the number of sequence items in the dialog

Specified by:
getCount in interface com.wewebu.ow.server.app.OwSequenceView

prev

public void prev(boolean fRemoveCurrent_p)
          throws Exception
move to prev item and roll over, i.e. start at the end one if first one is reached

Specified by:
prev in interface com.wewebu.ow.server.app.OwSequenceView
Parameters:
fRemoveCurrent_p - true = remove the current sequence item and then move to the prev item, if this is the last item, closes the dialog
Throws:
Exception

next

public void next(boolean fRemoveCurrent_p)
          throws Exception
move to next item and roll over, i.e. start at the first one if end is reached

Specified by:
next in interface com.wewebu.ow.server.app.OwSequenceView
Parameters:
fRemoveCurrent_p - true = remove the current sequence item and then move to the next item, if this is the last item, closes the dialog
Throws:
Exception

closeDialog

public void closeDialog()
                 throws Exception
visually close the Dialog. The behavior depends on usage If this view is a child of a DialogManager, the View gets removed from it.

Overrides:
closeDialog in class com.wewebu.ow.server.ui.OwDialog
Throws:
Exception

onObjectListViewFilterChange

public void onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p,
                                         com.wewebu.ow.server.ecm.OwObject parent_p)
                                  throws Exception
Specified by:
onObjectListViewFilterChange in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Throws:
Exception

onObjectListViewItemClick

public boolean onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p)
                                  throws Exception
called when uses clicks on a folder, used to redirect folder events an bypass the mimemanager

Specified by:
onObjectListViewItemClick in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Parameters:
obj_p - OwObject folder object that was clicked
Returns:
boolean true = event was handled, false = event was not handled, do default handler
Throws:
Exception

createHistoryView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectHistoryView createHistoryView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                      com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                               throws Exception
overridable factory method to create and init the history view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectHistoryView
Throws:
Exception

createLinksView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectLinksView createLinksView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                  com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                           throws com.wewebu.ow.server.exceptions.OwException
overridable factory method to create and init the edit links view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectEditVersionsView
Throws:
com.wewebu.ow.server.exceptions.OwException
Since:
4.1.1.0

createEditVersionsView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectEditVersionsView createEditVersionsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                                com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                                         throws Exception
overridable factory method to create and init the edit versions view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectEditVersionsView
Throws:
Exception

createFiledRecordsView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectFiledRecordsView createFiledRecordsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                                com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                                         throws Exception
overridable factory method to create and init the filed records view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectFiledRecordsView
Throws:
Exception

createAccessRightsView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectAccessRightsView createAccessRightsView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                                com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                                         throws Exception
overridable factory method to create and init the access rights view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectAccessRightsView
Throws:
Exception

createSystemPropertyView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createSystemPropertyView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                              com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                                       throws Exception
overridable factory method to create and init the system property view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectPropertyView
Throws:
Exception

createPropertyView

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createPropertyView(com.wewebu.ow.server.app.OwSubNavigationView nav_p,
                                                                                        com.wewebu.ow.server.ecm.OwObject obj_p)
                                                                                 throws Exception
overridable factory method to create and init the property view

Parameters:
nav_p -
obj_p -
Returns:
the newly created OwObjectPropertyView
Throws:
Exception

addExtraMenuButtons

protected void addExtraMenuButtons(com.wewebu.ow.server.dmsdialogs.OwPropertyViewBridge propertyViewBridge_p)
                            throws Exception
Add extra buttons (Save+next, Save+close, Save all) to the properties view.

Parameters:
propertyViewBridge_p -
Throws:
Exception
Since:
3.1.0.0

createPropertyViewInstance

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createPropertyViewInstance()
Create property view instance

Returns:
property view instance
Since:
2.5.2.0

createSystemPropertyViewInstance

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView createSystemPropertyViewInstance()
Create system property view instance

Returns:
property view instance
Since:
2.5.2.0

onPropertiesSavePlusNext

public boolean onPropertiesSavePlusNext(javax.servlet.http.HttpServletRequest request_p,
                                        Object oReason_p)
                                 throws Exception
Method handler used when user press the button "Save + next"

Parameters:
request_p - - the HTTP request
oReason_p - - the reason
Returns:
true if both save and next operations succeeded.
Throws:
Exception
Since:
3.0.0.0

onPropertiesNext

public boolean onPropertiesNext(javax.servlet.http.HttpServletRequest request_p,
                                Object oReason_p)
                         throws Exception
Method handler used when user press the button "Save + next"

Parameters:
request_p - - the HTTP request
oReason_p - - the reason
Returns:
true if both save and next operations succeeded.
Throws:
Exception
Since:
3.0.0.0

onPropertiesSavePlusClose

public boolean onPropertiesSavePlusClose(javax.servlet.http.HttpServletRequest request_p,
                                         Object oReason_p)
                                  throws Exception
Method handler used when user press the button "Save + close"

Parameters:
request_p - - the HTTP request
oReason_p - - the reason
Returns:
true if both save and close operations succeeded.
Throws:
Exception
Since:
3.0.0.0

onPropertiesSaveAll

public boolean onPropertiesSaveAll(javax.servlet.http.HttpServletRequest request_p,
                                   Object oReason_p)
                            throws Exception
event called when user clicked SaveAll button in the menu of the property view

Parameters:
request_p - a HttpServletRequest
oReason_p - Optional reason object submitted in addMenuItem
Returns:
a boolean
Throws:
Exception

onObjectListViewGetRowClassName

public String onObjectListViewGetRowClassName(int iIndex_p,
                                              com.wewebu.ow.server.ecm.OwObject obj_p)
get the style class name for the row

Specified by:
onObjectListViewGetRowClassName in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Parameters:
iIndex_p - int row index
obj_p - current OwObject
Returns:
String with style class name, or null to use default

onCancel

public boolean onCancel(javax.servlet.http.HttpServletRequest request_p,
                        Object oReason_p)
                 throws Exception
event called when user clicked Cancel button in the menu of the property view

Parameters:
request_p - a HttpServletRequest
oReason_p - Optional reason object submitted in addMenuItem
Returns:
a boolean
Throws:
Exception

setGroupPropertiesConfiguration

public void setGroupPropertiesConfiguration(com.wewebu.ow.server.dmsdialogs.OwGroupPropertiesConfiguration groupPropertyConfiguration_p)
Set the configuration for grouped properties.

Parameters:
groupPropertyConfiguration_p - - the configuration object.
Since:
3.1.0.0

getGroupPropertiesConfiguration

protected com.wewebu.ow.server.dmsdialogs.OwGroupPropertiesConfiguration getGroupPropertiesConfiguration()
Get the current configuration for grouping of properties.

Returns:
OwGroupPropertiesConfiguration
Since:
3.1.0.0

getJspConfigurator

public com.wewebu.ow.server.app.OwJspFormConfigurator getJspConfigurator()
Specified by:
getJspConfigurator in interface com.wewebu.ow.server.ui.OwJspConfigurable

setJspConfigurator

public void setJspConfigurator(com.wewebu.ow.server.app.OwJspFormConfigurator jspFormConfigurator_p)
Specified by:
setJspConfigurator in interface com.wewebu.ow.server.ui.OwJspConfigurable

setDisplayNoSaveMsg

public void setDisplayNoSaveMsg(boolean display_p)
Set the flag if "no save" message(s) should be displayed or not.

Parameters:
display_p - boolean flag
Since:
3.1.0.3

displayNoSaveMsg

public boolean displayNoSaveMsg()
Display "no save" message. By default this flag is set to false.

Returns:
boolean flag
Since:
3.1.0.3
See Also:
setDisplayNoSaveMsg(boolean)

setCloseDlgWOSaving

public void setCloseDlgWOSaving(boolean closeDlg_p)
Set the flag if the Dialog should be closed if no save was executed.

Parameters:
closeDlg_p - boolean flag
Since:
3.1.0.3

closeDlgWOSaving

public boolean closeDlgWOSaving()
Should dialog be closed, even if save was not executed.

By default the value is true.

Returns:
boolean flag
Since:
3.1.0.3
See Also:
setCloseDlgWOSaving(boolean)

createMimeManager

protected com.wewebu.ow.server.app.OwMimeManager createMimeManager()
(overridable) Factory method to create a OwMimeManger to be used by this instance.

Returns:
OwMimeManager
Since:
3.1.0.3


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.