com.wewebu.ow.server.plug.owdocprops

Class OwStatusIconDocumentFunction

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwDocumentFunction

com.wewebu.ow.server.plug.owdocprops.OwStatusIconDocumentFunction

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin

public class OwStatusIconDocumentFunction
extends com.wewebu.ow.server.app.OwDocumentFunction

A document function that displays a status icon dependent on document property states.

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

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

Constructors

Constructor and Description
OwStatusIconDocumentFunction()

Method Summary

Methods

Modifier and Type	Method and Description
protected OwStatusIconRule	createStatusIconRule(com.wewebu.ow.server.util.OwXMLUtil config, com.wewebu.ow.server.ui.OwAppContext context) Factory method for OwStatusIconRule instances from provided configuration
String	getBigIcon() get the big (24x24 pixels) icon URL for this plugin to be displayed
boolean	getContextMenu() get property from the XML plugin config node
String	getDisplayName(Locale locale_p, String description)
String	getIcon() get the small (16x16 pixels) icon URL for this plugin to be displayed
String	getIconHTML(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p) get the HTML code for the small (16x16 pixels) icon for this plugin to be displayed in the object list.
boolean	getMultiselect() get property from the XML plugin config node
boolean	getNoEvent() check if the plugin handles events with function calls, or if it is just used to display an icon.
boolean	getObjectInstance() get property from the XML plugin config node
protected List<OwStatusIconRule>	getRules() Getter of configured rules list.
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 object_p, com.wewebu.ow.server.ecm.OwObject parent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)

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

addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getColumnTitle, getDefaultIconHTML, getDefaultLabel, getDisplayNameFromUserId, getEnableColumnClickEvent, getLabel, getNeedParent, getPluginType, getRetrievalPropertyNames, getShowInEditViews, isEnabled, isEnabled, isObjectTypeSupported, onColumnClickEvent, onMultiselectClickEvent

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

getConfigNode, getContext, getDragDropProperties, getEventManager, getHelpPath, getName, 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

OwStatusIconDocumentFunction

public OwStatusIconDocumentFunction()

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 small (16x16 pixels) icon URL for this plugin to be displayed

Specified by:

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

Overrides:

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

Returns:

String icon URL

Throws:

Exception

getBigIcon

public String getBigIcon()
                  throws Exception

get the big (24x24 pixels) icon URL for this plugin to be displayed

Overrides:

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

Returns:

String icon URL

Throws:

Exception

getObjectInstance

public boolean getObjectInstance()

get property from the XML plugin config node

Overrides:

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

getContextMenu

public boolean getContextMenu()

get property from the XML plugin config node

Overrides:

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

getMultiselect

public boolean getMultiselect()

get property from the XML plugin config node

Overrides:

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

getNoEvent

public boolean getNoEvent()

check if the plugin handles events with function calls, or if it is just used to display an icon. The default is false, i.e. plugin handles events.

Overrides:

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

Returns:

boolean true = handles events, false = does not handle events

getIconHTML

public String getIconHTML(com.wewebu.ow.server.ecm.OwObject oObject_p,
                 com.wewebu.ow.server.ecm.OwObject oParent_p)
                   throws Exception

get the HTML code for the small (16x16 pixels) icon for this plugin to be displayed in the object list. An anchor tag is wrapped around this HTML code to trigger events for the plugin. NOTE: you can return arbitrary HTML here, if you do not want to display an icon.

Overrides:

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

Parameters:

oObject_p - OwObject where event was triggered

oParent_p - Parent which listed the Object

Returns:

HTML code to be inserted for the document function plugin.

Throws:

Exception

getDisplayName

public String getDisplayName(Locale locale_p,
                    String description)

onClickEvent

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

Specified by:

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

Throws:

Exception

getRules

protected List<OwStatusIconRule> getRules()

Getter of configured rules list.

Returns:

List of OwStatusIconRule

Since:

4.2.0.0

createStatusIconRule

protected OwStatusIconRule createStatusIconRule(com.wewebu.ow.server.util.OwXMLUtil config,
                                    com.wewebu.ow.server.ui.OwAppContext context)
                                         throws com.wewebu.ow.server.exceptions.OwException

Factory method for OwStatusIconRule instances from provided configuration

Parameters:

config - OwXMLUtil defined configuration of OwStatusIconRule

context - OwAppContext current Application context

Returns:

OwStatusIconRule

Throws:

com.wewebu.ow.server.exceptions.OwException - if unsupported or incorrect configured