com.wewebu.ow.server.settingsimpl
Class OwSettingsPropertyBagWrapper

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.app.OwSettingsPropertyControl
          extended by com.wewebu.ow.server.settingsimpl.OwSettingsPropertyBagWrapper
All Implemented Interfaces:
OwSettingsProperty

public abstract class OwSettingsPropertyBagWrapper
extends OwSettingsPropertyControl

Base class for property controls that display a set of named settings.
For each entry a menu button is displayed and the specified control will
be shown embedded when selecting the menu. e.g. used to configure column settings for several Views in BPM.

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 interface com.wewebu.ow.server.app.OwSettingsProperty
ITEM_VALUE_NODE
 
Constructor Summary
OwSettingsPropertyBagWrapper()
           
 
Method Summary
protected  Object createSingleClonedValue(Object oSingleValue_p)
          create a clone out of the given single property value
 String getDisplayName()
          get display name of property
 String getName()
          get ID of property
 String getSafePropertyError()
          gets a error message for this field, if update failed, clears the message automatically
 Object getValue()
          get current value of property
 Node getValueNode(Document doc_p)
          return the property value as a DOM Node for serialization
protected  void init()
          init the target after the context is set.
 void init(Node propertyDefinitionNode_p, Node valueNode_p, String strSetName_p)
          set current value of property, to be overridden
 void insertFormField(Writer w_p)
          insert the property into a HTML form for editing
 boolean isEditable()
          get flag indicating if property can be edited
 boolean isModified()
          true = value was modified, false otherwise
 boolean isUser()
          get flag indicating if property can be edited
 void setDefault()
          set the default value
 void setValue(Object value_p)
          set current value of property, to be overridden
 
Methods inherited from class com.wewebu.ow.server.app.OwSettingsPropertyControl
getHelpPath, getPropertyError, hasError
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OwSettingsPropertyBagWrapper

public OwSettingsPropertyBagWrapper()
Method Detail

getDisplayName

public String getDisplayName()
Description copied from class: OwSettingsPropertyControl
get display name of property

Specified by:
getDisplayName in class OwSettingsPropertyControl
Returns:
String display name

createSingleClonedValue

protected Object createSingleClonedValue(Object oSingleValue_p)
Description copied from class: OwSettingsPropertyControl
create a clone out of the given single property value

Specified by:
createSingleClonedValue in class OwSettingsPropertyControl
Parameters:
oSingleValue_p - single Object value
Returns:
Object

insertFormField

public void insertFormField(Writer w_p)
                     throws Exception
Description copied from class: OwSettingsPropertyControl
insert the property into a HTML form for editing

Specified by:
insertFormField in class OwSettingsPropertyControl
Parameters:
w_p - Writer to write HTML code to
Throws:
Exception

getSafePropertyError

public String getSafePropertyError()
Description copied from class: OwSettingsPropertyControl
gets a error message for this field, if update failed, clears the message automatically

Specified by:
getSafePropertyError in class OwSettingsPropertyControl
Returns:
String error message or an empty string

isModified

public boolean isModified()
Description copied from class: OwSettingsPropertyControl
true = value was modified, false otherwise

Specified by:
isModified in class OwSettingsPropertyControl

init

protected void init()
             throws Exception
Description copied from class: OwEventTarget
init the target after the context is set.

Specified by:
init in class OwEventTarget
Throws:
Exception

setDefault

public void setDefault()
Description copied from interface: OwSettingsProperty
set the default value


getValueNode

public Node getValueNode(Document doc_p)
Description copied from interface: OwSettingsProperty
return the property value as a DOM Node for serialization

Parameters:
doc_p - DOM Document to add to
Returns:
Node

isUser

public boolean isUser()
Description copied from interface: OwSettingsProperty
get flag indicating if property can be edited

Returns:
boolean true = editable

isEditable

public boolean isEditable()
Description copied from interface: OwSettingsProperty
get flag indicating if property can be edited

Returns:
boolean true = editable

getName

public String getName()
Description copied from interface: OwSettingsProperty
get ID of property

Returns:
String with ID

init

public void init(Node propertyDefinitionNode_p,
                 Node valueNode_p,
                 String strSetName_p)
          throws Exception
Description copied from interface: OwSettingsProperty
set current value of property, to be overridden

Parameters:
propertyDefinitionNode_p - the node which defines the property in the plugin descriptors setting
valueNode_p - the node with the current value
strSetName_p - name of the property set for which the property is created
Throws:
Exception

getValue

public Object getValue()
Description copied from interface: OwSettingsProperty
get current value of property

Returns:
Object if isList() is true, Object otherwise

setValue

public void setValue(Object value_p)
Description copied from interface: OwSettingsProperty
set current value of property, to be overridden

Parameters:
value_p - Object


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.