com.wewebu.ow.server.plug.owaddmultidocuments

Class OwMultiDocumentObjectPropertyView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

com.wewebu.ow.server.plug.owaddmultidocuments.OwMultiDocumentObjectPropertyView

All Implemented Interfaces:

com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler, com.wewebu.ow.server.field.OwFieldProvider, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwMultipanel, com.wewebu.ow.server.ui.OwUpdateTarget

public class OwMultiDocumentObjectPropertyView
extends com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView
implements com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

View Module to edit OwObject Properties.

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.dmsdialogs.views.OwObjectPropertyView

com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView.OwPropertyInfo

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion, com.wewebu.ow.server.ui.OwLayout.OwLayoutViewRefrence

Field Summary

Fields

Modifier and Type	Field and Description
protected com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler	m_checkInHandler the check in handler
protected int	m_saveAllButtonIndex menu ID of the SaveAll button

Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

BATCH_INDEX_PROPERTIES_ATTRIBTUE_BAG_NAME, ERRORS_REGION, GROUP_COLLAPSED_CLASS_NAME, GROUP_EXPANDED_CLASS_NAME, m_batchIndexProperties, m_batchPropertiesHandler, m_enablesaveall, m_fAllPropertiesReadonly, m_fReadOnly, m_fSystem, m_iAppyBtnIndex, m_iLockIndex, m_iNextButtonIndex, m_iUnLockIndex, m_iViewMask, m_MenuView, m_ObjectRef, m_pasteMetadataHandler, m_Properties, m_ReadOnlyContext, m_readOnlyProperties, m_saveAllActive, m_theFieldManager, MAIN_REGION, MENU_REGION, MODES_REGION, QUERY_KEY_PROPNAME, VIEW_MASK_DISABLE_INTERNAL_MENU, VIEW_MASK_ENABLE_PASTE_METADATA, VIEW_MASK_READONLY, VIEW_MASK_RENDER_VERTICAL

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.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
OwMultiDocumentObjectPropertyView(boolean enablesaveall_p)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeCheckinOptions(javax.servlet.http.HttpServletRequest request_p) Compute the checkin options.
protected com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler	createCheckInHandler() Creates the OwCheckInHandler object
Object	getCheckinModeObject()
Collection<org.alfresco.wd.ui.conf.prop.OwPropertyInfo>	getVirtualParentRestriction() Get defined restrictions
protected void	init() init the target after the context is set.
protected boolean	isPropertyReadonly(com.wewebu.ow.server.ecm.OwProperty property_p)
boolean	isReleaseVersion()
boolean	onApply(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked Apply button in menu
protected boolean	onApplyInternal(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called to save changes call getUpdateStatus() after save to check if fields are invalid
boolean	onSaveAll(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked SaveAll button in menu
protected boolean	onSaveAllInternal(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called to save changes call getUpdateStatus() after save to check if fields are invalid
void	renderCheckInModes(Writer w_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
void	renderCheckInOptions(Writer w_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
protected void	renderMainRegion(Writer w_p) render the main region with the property list overrides the OwObjectPropertyView.renderMainRegin method in order to display checkin options
protected void	renderMenuRegion(Writer w_p) render the menu region with the release box and checkin modes overrides the OwObjectPropertyView.renderMenuRegion method in order to display checkin options
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
void	setCheckInOptions(List modes_p, boolean fDisplayReleaseBox_p) display checkin options
void	setCheckInVersionMajor(boolean checkInAsMajorVersion_p) set if check-in Version is major or minor
void	setEventListener(OwMultiDocumentObjectPropertyViewListner eventListener_p)
void	setVirtualParentRestriction(Collection<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> propInfoList) Set a list of virtual parent defined restrictions

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

clearBatchIndex, createBatchPropertiesHandler, createPasteMetadataHandler, detach, getClipboard, getField, getFieldManager, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getFilteredClonedProperties, getMenu, getObjectRef, getPropertyListConfiguration, getReadOnlyContext, getRowClassName, getSafeFieldValue, getSaveBtnIndex, getSubregionAvailable, getUpdateStatus, hasViewMask, informUserOnSuccess, isGroupWithErrors, isReadOnly, isRegion, isSupportLock, isSystemPropertyView, isValidated, mapProperties, onAjaxPropertyGroupCollapse, onBatchIndex, onLock, onNext, onPasteAllMetaData, onPasteThisMetaData, onRender, onUnLock, onUpdate, renderErrorsRegion, renderExtraColumnHeader, renderExtraColumnRows, renderGroupHeader, renderHorizontalProperties, renderHorizontalProperty, renderHorizontalPropertyGroups, renderModesRegion, renderPropertyGroup, renderPropertyListConfiguration, renderVertically, save, setBatchProperties, setDisplayNoSaveMsg, setField, setGroupPropertiesConfiguration, setInformUserOnSuccess, setModeType, setNextActivateView, setObjectRef, setObjectRefEx, setPrevActivateView, setPropertyListConfiguration, setReadOnlyContext, setSaveAllActive, setSaveBtnIndex, setUpdateNoChanges, setViewMask, update, updateExternalFormTarget, usesFormWithAttributes

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, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest

Methods inherited from class java.lang.Object

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

Field Detail

m_saveAllButtonIndex

protected int m_saveAllButtonIndex

menu ID of the SaveAll button

m_checkInHandler

protected com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler m_checkInHandler

the check in handler

Constructor Detail

OwMultiDocumentObjectPropertyView

public OwMultiDocumentObjectPropertyView(boolean enablesaveall_p)

Parameters:

enablesaveall_p - flag to enable save all button option when more than one documents are selected

Method Detail

createCheckInHandler

protected com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler createCheckInHandler()

Creates the OwCheckInHandler object

Returns:

the newly created OwCheckInHandler object

Since:

3.1.0.0

setEventListener

public void setEventListener(OwMultiDocumentObjectPropertyViewListner eventListener_p)

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

Throws:

Exception

onApply

public boolean onApply(javax.servlet.http.HttpServletRequest request_p,
              Object oReason_p)
                throws Exception

event called when user clicked Apply button in menu

Overrides:

onApply in class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

Parameters:

request_p - a HttpServletRequest

oReason_p - Optional reason object submitted in addMenuItem

Throws:

Exception

onSaveAll

public boolean onSaveAll(javax.servlet.http.HttpServletRequest request_p,
                Object oReason_p)
                  throws Exception

event called when user clicked SaveAll button in menu

Parameters:

request_p - a HttpServletRequest

oReason_p - Optional reason object submitted in addMenuItem

Throws:

Exception

computeCheckinOptions

public void computeCheckinOptions(javax.servlet.http.HttpServletRequest request_p)

Compute the checkin options.

Specified by:

computeCheckinOptions in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

Parameters:

request_p - - the HttpServletRequest object

onApplyInternal

protected boolean onApplyInternal(javax.servlet.http.HttpServletRequest request_p,
                      Object oReason_p)
                           throws Exception

event called to save changes call getUpdateStatus() after save to check if fields are invalid

Overrides:

onApplyInternal in class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

Parameters:

request_p - a HttpServletRequest

oReason_p - Optional reason object submitted in addMenuItem

Returns:

true = fields have been saved, false = nothing has been saved

Throws:

Exception

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.dmsdialogs.views.OwObjectPropertyView

Parameters:

w_p - Writer object to write HTML to

iRegion_p - ID of the region to render

Throws:

Exception

onSaveAllInternal

protected boolean onSaveAllInternal(javax.servlet.http.HttpServletRequest request_p,
                        Object oReason_p)
                             throws Exception

event called to save changes call getUpdateStatus() after save to check if fields are invalid

Parameters:

request_p - a HttpServletRequest

oReason_p - Optional reason object submitted in addMenuItem

Returns:

true = fields have been saved, false = nothing has been saved

Throws:

Exception

setCheckInOptions

public void setCheckInOptions(List modes_p,
                     boolean fDisplayReleaseBox_p)
                       throws Exception

display checkin options

Specified by:

setCheckInOptions in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

Parameters:

modes_p - List of modes as defined in OwVersion

fDisplayReleaseBox_p - boolean true = display a release checkbox

Throws:

Exception

setCheckInVersionMajor

public void setCheckInVersionMajor(boolean checkInAsMajorVersion_p)

set if check-in Version is major or minor

Specified by:

setCheckInVersionMajor in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

Parameters:

checkInAsMajorVersion_p -

renderMainRegion

protected void renderMainRegion(Writer w_p)
                         throws Exception

render the main region with the property list overrides the OwObjectPropertyView.renderMainRegin method in order to display checkin options

Overrides:

renderMainRegion in class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

renderMenuRegion

protected void renderMenuRegion(Writer w_p)
                         throws Exception

render the menu region with the release box and checkin modes overrides the OwObjectPropertyView.renderMenuRegion method in order to display checkin options

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

renderCheckInModes

public void renderCheckInModes(Writer w_p,
                      com.wewebu.ow.server.app.OwMainAppContext context_p)
                        throws Exception

Specified by:

renderCheckInModes in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

Throws:

Exception

getCheckinModeObject

public Object getCheckinModeObject()

Specified by:

getCheckinModeObject in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

isReleaseVersion

public boolean isReleaseVersion()

Specified by:

isReleaseVersion in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

renderCheckInOptions

public void renderCheckInOptions(Writer w_p,
                        com.wewebu.ow.server.app.OwMainAppContext context_p)
                          throws Exception

Specified by:

renderCheckInOptions in interface com.wewebu.ow.server.dmsdialogs.views.OwCheckInHandler

Throws:

Exception

setVirtualParentRestriction

public void setVirtualParentRestriction(Collection<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> propInfoList)

Set a list of virtual parent defined restrictions

Parameters:

propInfoList - List of OwPropertyInfo

Since:

4.2.0.0

getVirtualParentRestriction

public Collection<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> getVirtualParentRestriction()

Get defined restrictions

Returns:

List of OwPropertyInfo

Since:

4.2.0.0

isPropertyReadonly

protected boolean isPropertyReadonly(com.wewebu.ow.server.ecm.OwProperty property_p)
                              throws Exception

Overrides:

isPropertyReadonly in class com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

Throws:

Exception