com.wewebu.ow.server.settingsimpl

Class OwSettingsPropertyStringCombo

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.app.OwSettingsPropertyControl

com.wewebu.ow.server.settingsimpl.OwAbstractSettingsPropertyControl

com.wewebu.ow.server.settingsimpl.OwSettingsPropertyBaseImpl

com.wewebu.ow.server.settingsimpl.OwSettingsPropertyStringCombo

All Implemented Interfaces:

OwSettingsProperty

Direct Known Subclasses:

OwSettingsPropertyClipboardBehavior, OwSettingsPropertyDisplayCombo, OwSettingsPropertyIntegerCombo, OwSettingsPropertyMasterRoles

public class OwSettingsPropertyStringCombo
extends OwSettingsPropertyBaseImpl

A single settings String property, with combo select box.

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

Modifier and Type	Field and Description
protected static String	COMBO_SELECT_ITEM_DISPLAY_ATTR_NAME attribute name of a combo select item display name for list properties
protected static String	COMBO_SELECT_ITEM_NODE_NAME node name of a combo select item for list properties

Fields inherited from class com.wewebu.ow.server.settingsimpl.OwSettingsPropertyBaseImpl

ITEM_PREFIX, ITEM_QUERY_KEY, m_defaultValue, m_fList, m_strError, m_value

Fields inherited from class com.wewebu.ow.server.settingsimpl.OwAbstractSettingsPropertyControl

m_externalFormEventTarget, m_propertyDefinitionNode, m_strSetName

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

ITEM_VALUE_NODE

Constructor Summary

Constructors

Constructor and Description
OwSettingsPropertyStringCombo()

Method Summary

Methods

Modifier and Type	Method and Description
protected List	createComboSelectList(Node valueNode_p) create a list of values, if property is a list
protected Object	createSingleClonedValue(Object oSingleValue_p) create a clone out of the given single property value
protected Object	getDefaultListItemValue() overridable to create a default value for list properties
protected Object	getSingleValueFromRequest(javax.servlet.http.HttpServletRequest request_p, String strID_p) overridable to apply changes on a submitted form
protected void	insertFormValue(Writer w_p, Object value_p, String strID_p, int iIndex_p) overridable to insert a single value into a edit HTML form

Methods inherited from class com.wewebu.ow.server.settingsimpl.OwSettingsPropertyBaseImpl

appendSingleValueNode, canAdd, createValue, createValueList, extractIDIndex, getMaxListSize, getPropertyError, getSafePropertyError, getSingleValue, getValue, getValueNode, hasError, init, insertFormField, insertLabel, insertLabelValue, isList, isModified, onAdd, onDelete, saved, setDefault, setValue, toString, updateExternalFormTarget, writeAddNewItemButton, writeDeleteButton

Methods inherited from class com.wewebu.ow.server.settingsimpl.OwAbstractSettingsPropertyControl

getDisplayName, getFormName, getFormTarget, getHelpPath, getName, getPropertyDefinitionNode, init, isEditable, isUser, setExternalFormTarget

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

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

Methods inherited from class java.lang.Object

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

Field Detail

COMBO_SELECT_ITEM_NODE_NAME

protected static final String COMBO_SELECT_ITEM_NODE_NAME

node name of a combo select item for list properties

See Also:

Constant Field Values

COMBO_SELECT_ITEM_DISPLAY_ATTR_NAME

protected static final String COMBO_SELECT_ITEM_DISPLAY_ATTR_NAME

attribute name of a combo select item display name for list properties

See Also:

Constant Field Values

Constructor Detail

OwSettingsPropertyStringCombo

public OwSettingsPropertyStringCombo()

Method Detail

createSingleClonedValue

protected Object createSingleClonedValue(Object oSingleValue_p)

create a clone out of the given single property value

Overrides:

createSingleClonedValue in class OwSettingsPropertyBaseImpl

Parameters:

oSingleValue_p - single Object value

Returns:

Object

createComboSelectList

protected List createComboSelectList(Node valueNode_p)
                              throws Exception

create a list of values, if property is a list

Parameters:

valueNode_p - Node with child value nodes

Returns:

List of Objects representing values

Throws:

Exception

insertFormValue

protected void insertFormValue(Writer w_p,
                   Object value_p,
                   String strID_p,
                   int iIndex_p)
                        throws Exception

overridable to insert a single value into a edit HTML form

Overrides:

insertFormValue in class OwSettingsPropertyBaseImpl

Parameters:

w_p - Writer to write HTML code to

value_p - the property value to edit

strID_p - String the ID of the HTML element for use in onApply

iIndex_p - int Index of item if it is a list

Throws:

Exception

getSingleValueFromRequest

protected Object getSingleValueFromRequest(javax.servlet.http.HttpServletRequest request_p,
                               String strID_p)

overridable to apply changes on a submitted form

Overrides:

getSingleValueFromRequest in class OwSettingsPropertyBaseImpl

Parameters:

request_p - HttpServletRequest with form data to update the property

strID_p - String the HTML form element ID of the requested value

getDefaultListItemValue

protected Object getDefaultListItemValue()
                                  throws Exception

overridable to create a default value for list properties

Overrides:

getDefaultListItemValue in class OwSettingsPropertyBaseImpl

Returns:

Object with default value for a new list item

Throws:

Exception