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

java.lang.Object
  com.wewebu.ow.server.app.OwFunction
      com.wewebu.ow.server.app.OwDocumentFunction
          com.wewebu.ow.server.plug.owdocprops.OwEditDocumentPropertiesFunction

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin, com.wewebu.ow.server.ui.OwDialog.OwDialogListener, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwEditDocumentPropertiesFunction
extends com.wewebu.ow.server.app.OwDocumentFunction
implements com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Implementation of the Document edit properties plugin.

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

Since:

3.1.0.0

Field Summary

Fields inherited from class com.wewebu.ow.server.app.OwFunction

DESCRIPTION_KEY_CLASSES, DESCRIPTION_KEY_OBJ_TYPES, DESCRIPTION_KEY_TYPE, DRAG_DROP_PROPERTY_MAX_FILESIZE, m_MainContext

Constructor Summary

OwEditDocumentPropertiesFunction()

Method Summary

protected OwEditPropertiesDialog	createPropertiesDialog(Collection objects_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p, int iMaxElementSize_p, Collection versionColumnInfo_p, com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p, Collection historyViewColumnInfo_p, Collection batchIndexProperties_p, com.wewebu.ow.server.ecm.OwObjectLinkRelation relationSplit_p, boolean displayTypedList_p, Collection<String> linkClassNames_p) overridable factory method to create the dialog
String	getBigIcon() get the URL to the info icon
String	getIcon() get the URL to the info icon
void	init(com.wewebu.ow.server.util.OwXMLUtil node_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
void	onClickEvent(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the label / icon
void	onDialogClose(com.wewebu.ow.server.ui.OwDialog dialogView_p)
void	onMultiselectClickEvent(Collection objects_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin for multiple selected items
void	onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p, int code_p, Object param_p)

Methods inherited from class com.wewebu.ow.server.app.OwDocumentFunction

addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getColumnTitle, getContextMenu, getDefaultIconHTML, getDefaultLabel, getDisplayNameFromUserId, getEnableColumnClickEvent, getIconHTML, getLabel, getMultiselect, getNeedParent, getObjectInstance, getPluginType, getRetrievalPropertyNames, getShowInEditViews, isEnabled, isEnabled, isObjectTypeSupported, onColumnClickEvent

Methods inherited from class com.wewebu.ow.server.app.OwFunction

getConfigNode, getContext, getDragDropProperties, getEventManager, getHelpPath, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isDragDropTarget, isObjectClassSupported, setSafeSetting

Methods inherited from class java.lang.Object

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

Constructor Detail

OwEditDocumentPropertiesFunction

public OwEditDocumentPropertiesFunction()

Method Detail

init

public void init(com.wewebu.ow.server.util.OwXMLUtil node_p,
                 com.wewebu.ow.server.app.OwMainAppContext context_p)
          throws Exception

Overrides:

init in class com.wewebu.ow.server.app.OwDocumentFunction

Throws:

Exception

getIcon

public String getIcon()
               throws Exception

get the URL to the info icon

Specified by:

getIcon in interface com.wewebu.ow.server.app.OwPlugin

Overrides:

getIcon in class com.wewebu.ow.server.app.OwFunction

Returns:

String URL

Throws:

Exception

getBigIcon

public String getBigIcon()
                  throws Exception

get the URL to the info icon

Overrides:

getBigIcon in class com.wewebu.ow.server.app.OwFunction

Returns:

String URL

Throws:

Exception

onClickEvent

public void onClickEvent(com.wewebu.ow.server.ecm.OwObject oObject_p,
                         com.wewebu.ow.server.ecm.OwObject oParent_p,
                         com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                  throws Exception

event called when user clicked the label / icon

Specified by:

onClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction

Parameters:

oObject_p - OwObject where event was triggered

oParent_p - Parent which listed the Object

refreshCtx_p - OwFunctionRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

onMultiselectClickEvent

public void onMultiselectClickEvent(Collection objects_p,
                                    com.wewebu.ow.server.ecm.OwObject oParent_p,
                                    com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                             throws Exception

event called when user clicked the plugin for multiple selected items

Overrides:

onMultiselectClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction

Parameters:

objects_p - Collection of OwObject

oParent_p - Parent which listed the Objects

refreshCtx_p - OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

createPropertiesDialog

protected OwEditPropertiesDialog createPropertiesDialog(Collection objects_p,
                                                        com.wewebu.ow.server.ecm.OwObject oParent_p,
                                                        com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p,
                                                        int iMaxElementSize_p,
                                                        Collection versionColumnInfo_p,
                                                        com.wewebu.ow.server.field.OwSearchTemplate historyViewSearchTemplate_p,
                                                        Collection historyViewColumnInfo_p,
                                                        Collection batchIndexProperties_p,
                                                        com.wewebu.ow.server.ecm.OwObjectLinkRelation relationSplit_p,
                                                        boolean displayTypedList_p,
                                                        Collection<String> linkClassNames_p)
                                                 throws Exception

overridable factory method to create the dialog

Parameters:

objects_p -

oParent_p -

refreshCtx_p -

iMaxElementSize_p -

versionColumnInfo_p -

historyViewSearchTemplate_p -

historyViewColumnInfo_p -

batchIndexProperties_p - Collection of batch index properties each property will be copied to the next pane

Returns:

the newly created OwEditPropertiesDialog

Throws:

Exception

onDialogClose

public void onDialogClose(com.wewebu.ow.server.ui.OwDialog dialogView_p)
                   throws Exception

Specified by:

onDialogClose in interface com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Throws:

Exception

onUpdate

public void onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p,
                     int code_p,
                     Object param_p)
              throws Exception

Specified by:

onUpdate in interface com.wewebu.ow.server.ui.OwUpdateTarget

Throws:

Exception