com.wewebu.ow.server.settingsimpl

Class OwAbstractSettingsPropertyControl

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.app.OwSettingsPropertyControl

com.wewebu.ow.server.settingsimpl.OwAbstractSettingsPropertyControl

All Implemented Interfaces:

OwSettingsProperty

Direct Known Subclasses:

OwSettingsPropertyBaseImpl, OwSettingsPropertyLanguageString

public abstract class OwAbstractSettingsPropertyControl
extends OwSettingsPropertyControl

Default abstract implementation of OwSettingsPropertyControl.

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:

4.2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected OwEventTarget	m_externalFormEventTarget external form view overrides internal form
protected Node	m_propertyDefinitionNode Deprecated. since 4.2.0.0 use getPropertyDefinitionNode()
protected String	m_strSetName set name

Fields inherited from interface com.wewebu.ow.server.app.OwSettingsProperty

ITEM_VALUE_NODE

Constructor Summary

Constructors

Constructor and Description
OwAbstractSettingsPropertyControl()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() get display name of property
String	getFormName() get the form used for the edit fields
OwEventTarget	getFormTarget() get the target, that is used for form data and renders form
String	getHelpPath() get optional help path for the control
String	getName() get ID of property
protected Node	getPropertyDefinitionNode() get a reference to the property definition node
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
boolean	isEditable() get flag indicating if property can be edited
boolean	isUser() get flag indicating if property can be edited
void	setExternalFormTarget(OwEventTarget eventTarget_p) override the internal form with an external one, must be called BEFORE event target is attached.
String	toString()

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

createSingleClonedValue, getPropertyError, getSafePropertyError, hasError, insertFormField, insertLabel, isModified

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.wewebu.ow.server.app.OwSettingsProperty

getValue, getValueNode, setDefault, setValue

Field Detail

m_propertyDefinitionNode

protected Node m_propertyDefinitionNode

Deprecated. since 4.2.0.0 use getPropertyDefinitionNode()

the defining node from the plugin descriptors setting set

m_strSetName

protected String m_strSetName

set name

m_externalFormEventTarget

protected OwEventTarget m_externalFormEventTarget

external form view overrides internal form

Constructor Detail

OwAbstractSettingsPropertyControl

public OwAbstractSettingsPropertyControl()

Method Detail

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

getHelpPath

public String getHelpPath()

Description copied from class: OwSettingsPropertyControl

get optional help path for the control

Specified by:

getHelpPath in class OwSettingsPropertyControl

Returns:

JSP path or null if no help is available

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

getDisplayName

public String getDisplayName()

Description copied from class: OwSettingsPropertyControl

get display name of property

Specified by:

getDisplayName in class OwSettingsPropertyControl

Returns:

String display name

getName

public String getName()

get ID of property

Returns:

String which is basically the NodeName

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

getPropertyDefinitionNode

protected Node getPropertyDefinitionNode()

get a reference to the property definition node

Returns:

Node (or null if not initialized yet)

getFormName

public String getFormName()

get the form used for the edit fields

Overrides:

getFormName in class OwEventTarget

Returns:

String form name

setExternalFormTarget

public void setExternalFormTarget(OwEventTarget eventTarget_p)
                           throws Exception

Description copied from class: OwEventTarget

override the internal form with an external one, must be called BEFORE event target is attached.
NOTE: By default, view will render its own form, unless you call setFormTarget When setting an external form, the view will not render a own form, but use the form name of the given OwEditable. ==> Several form-views can update each other.

Overrides:

setExternalFormTarget in class OwEventTarget

Parameters:

eventTarget_p - OwEventTarget to be used for form data

Throws:

Exception

getFormTarget

public OwEventTarget getFormTarget()

Description copied from class: OwEventTarget

get the target, that is used for form data and renders form

Overrides:

getFormTarget in class OwEventTarget

Returns:

OwEventTarget

toString

public String toString()

Overrides:

toString in class Object