com.wewebu.ow.server.app
Class OwSettingsPropertyControl

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.app.OwSettingsPropertyControl
All Implemented Interfaces:
OwSettingsProperty
Direct Known Subclasses:
OwSettingsPropertyBagWrapper, OwSettingsPropertyBaseImpl, OwSettingsPropertyLanguageString

public abstract class OwSettingsPropertyControl
extends OwEventTarget
implements OwSettingsProperty

Base class for a single settings property controls used in the OwSettings for the plugins.
Implements OwSettingsProperty and adds control UI functionality.
Unlike configuration node entries, the settings are stored for each user or for a site, where the configuration via getConfigNode is only set during startup.

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
OwSettingsPropertyControl()
           
 
Method Summary
protected abstract  Object createSingleClonedValue(Object oSingleValue_p)
          create a clone out of the given single property value
abstract  String getDisplayName()
          get display name of property
abstract  String getHelpPath()
          get optional help path for the control
abstract  String getPropertyError()
          Gets a error message for this field
abstract  String getSafePropertyError()
          gets a error message for this field, if update failed, clears the message automatically
abstract  boolean hasError()
          Check if this property has an error associated, without clear the error message
abstract  void insertFormField(Writer w_p)
          insert the property into a HTML form for editing
abstract  boolean isModified()
          true = value was modified, false otherwise
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, init, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.wewebu.ow.server.app.OwSettingsProperty
getName, getValue, getValueNode, init, isEditable, isUser, setDefault, setValue
 

Constructor Detail

OwSettingsPropertyControl

public OwSettingsPropertyControl()
Method Detail

getHelpPath

public abstract String getHelpPath()
get optional help path for the control

Returns:
JSP path or null if no help is available

getDisplayName

public abstract String getDisplayName()
get display name of property

Returns:
String display name

createSingleClonedValue

protected abstract Object createSingleClonedValue(Object oSingleValue_p)
create a clone out of the given single property value

Parameters:
oSingleValue_p - single Object value
Returns:
Object

insertFormField

public abstract void insertFormField(Writer w_p)
                              throws Exception
insert the property into a HTML form for editing

Parameters:
w_p - Writer to write HTML code to
Throws:
Exception

getSafePropertyError

public abstract String getSafePropertyError()
gets a error message for this field, if update failed, clears the message automatically

Returns:
String error message or an empty string

isModified

public abstract boolean isModified()
true = value was modified, false otherwise


hasError

public abstract boolean hasError()
Check if this property has an error associated, without clear the error message

Since:
2.5.2.0

getPropertyError

public abstract String getPropertyError()
Gets a error message for this field

Returns:
String error message or an empty string
Since:
2.5.2.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.