com.wewebu.ow.server.fieldctrlimpl.dynamic

Class OwDependentComboboxFieldControl

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.app.OwFieldManagerControl

com.wewebu.ow.server.fieldctrlimpl.dynamic.OwDependentComboboxFieldControl

public class OwDependentComboboxFieldControl
extends OwFieldManagerControl

Configurable dependency FieldControl.
Can load values dependent on other field values, from different Data provider.

There two configuration nodes which are handled by default in the field control:

• Active
• DependentData

Active is an optional node, and define the context/provider type where the control should be active.
<Active search="true|false" edit="true|false" create="true|false" checkin="true|false" />

Configuration must have a <DependentData> node which provide the information of dependent handling.

 <DependentData class="com.wewebu.ow.server.fieldctrlimpl.dynamic.OwDependentComboboxDataHandler">
 ...
 <DependentData>
 

The <DependentData> can have an attribute class to define corresponding DependentDataHandler. Definitions must implement the OwDependentComboboxDataHandler interface, by default com.wewebu.ow.server.fieldctrlimpl.dynamic.OwDBDependentComboboxDataHandler is defined.

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
static String	EL_ACTIVE
static String	EL_DEPENDENT_DATA

Constructor Summary

Constructors

Constructor and Description
OwDependentComboboxFieldControl()

Method Summary

Methods

Modifier and Type	Method and Description
protected OwComboModel	createComboModel(OwField field, List<OwComboItem> items) (overridable) Factory method for creation of the combo model, for combo box rendering.
protected OwXMLUtil	getConfig()
protected OwDependentComboboxDataHandler	getDataHandler()
protected void	init() init the target after the context is set.
void	init(OwFieldManager fieldmanager_p, Node configNode_p) initialization of a field control to display fields
protected void	insertComboField(Writer w, OwFieldDefinition fieldDef, OwField field, String strID) Render a combo box for value representations.
void	insertEditField(Writer w, OwFieldDefinition fieldDef, OwField field, String strID) format and displays the value attached to the fieldClass in HTML for use in a HTML Form.
protected void	insertEditTextField(Writer w, OwFieldDefinition fieldDef, Object currentValue, String id) (overridable) Default rendering in case combo box should not be rendered.
void	insertReadOnlyField(Writer w, OwFieldDefinition fieldDef_p, Object value_p) format and displays the value attached to the PropertyClass in HTML
protected boolean	isActiveContext() (overridable) Verify if this instance should be active in current context/ field provider type.
void	onAjaxGetComboItems(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	processDataResponse(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, List<OwComboItem> items)
Object	updateField(javax.servlet.http.HttpServletRequest request_p, OwFieldDefinition fieldDef_p, Object value_p, String strID_p) update the property value upon request and validates the new value.

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

getFieldManager, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, insertLabel

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

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

Methods inherited from class java.lang.Object

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

Field Detail

EL_ACTIVE

public static final String EL_ACTIVE

See Also:

Constant Field Values

EL_DEPENDENT_DATA

public static final String EL_DEPENDENT_DATA

See Also:

Constant Field Values

Constructor Detail

OwDependentComboboxFieldControl

public OwDependentComboboxFieldControl()

Method Detail

init

public void init(OwFieldManager fieldmanager_p,
        Node configNode_p)
          throws Exception

Description copied from class: OwFieldManagerControl

initialization of a field control to display fields

Overrides:

init in class OwFieldManagerControl

Parameters:

fieldmanager_p - OwFieldManager reference to the field manager containing the field control

configNode_p - DOM Node to the configuration XML for the control, or null to use defaults

Throws:

Exception

init

protected void init()
             throws Exception

Description copied from class: OwEventTarget

init the target after the context is set.

Overrides:

init in class OwFieldManagerControl

Throws:

Exception

insertReadOnlyField

public void insertReadOnlyField(Writer w,
                       OwFieldDefinition fieldDef_p,
                       Object value_p)
                         throws Exception

Description copied from class: OwFieldManagerControl

format and displays the value attached to the PropertyClass in HTML

Specified by:

insertReadOnlyField in class OwFieldManagerControl

Parameters:

w - Writer object to write HTML to

fieldDef_p - OwFieldDefinition definition of field

value_p - Object Value to be displayed

Throws:

Exception

insertEditField

public void insertEditField(Writer w,
                   OwFieldDefinition fieldDef,
                   OwField field,
                   String strID)
                     throws Exception

Description copied from class: OwFieldManagerControl

format and displays the value attached to the fieldClass in HTML for use in a HTML Form. It also creates the necessary code to update the value in the form upon request.

Specified by:

insertEditField in class OwFieldManagerControl

Parameters:

w - Writer object to write HTML to

fieldDef - OwFieldDefinition

field - OwField Value to be displayed

strID - ID of the HTML element

Throws:

Exception

insertComboField

protected void insertComboField(Writer w,
                    OwFieldDefinition fieldDef,
                    OwField field,
                    String strID)
                         throws OwException,
                                IOException

Render a combo box for value representations. Will retrieve Data for rendering from getDataHandler(), afterwards the retrieved Data is converted into OwComboModel representation calling createComboModel(OwField, List) method.
If everything is successful the rendering of combo box will be processed.

Parameters:

w - Writer

fieldDef - OwFieldDefinition of field to be rendered

field - OwField dependent field

strID - String for the rendered component

Throws:

OwException - if rendering cannot be processed.

IOException

createComboModel

protected OwComboModel createComboModel(OwField field,
                            List<OwComboItem> items)
                                 throws OwException

(overridable) Factory method for creation of the combo model, for combo box rendering.

Parameters:

field - OwField

items - List of OwComboItems

Returns:

OwComboModel

Throws:

OwException - if cannot create model from provided information

insertEditTextField

protected void insertEditTextField(Writer w,
                       OwFieldDefinition fieldDef,
                       Object currentValue,
                       String id)
                            throws OwException,
                                   IOException

(overridable) Default rendering in case combo box should not be rendered.

Parameters:

w - Writer

fieldDef - OwFieldDefinition

currentValue - Object

id - String for rendered representation item

Throws:

OwException

IOException

updateField

public Object updateField(javax.servlet.http.HttpServletRequest request_p,
                 OwFieldDefinition fieldDef_p,
                 Object value_p,
                 String strID_p)
                   throws Exception

Description copied from class: OwFieldManagerControl

update the property value upon request and validates the new value. Updates the object, which was displayed in a form using the getEditHTML(...) code. Throws Exception if new value could not be validated

Specified by:

updateField in class OwFieldManagerControl

Parameters:

request_p - HttpServletRequest

fieldDef_p - OwFieldDefinition

value_p - Object old Value

strID_p - ID of the HTML element

Throws:

Exception

getConfig

protected OwXMLUtil getConfig()

getDataHandler

protected OwDependentComboboxDataHandler getDataHandler()

onAjaxGetComboItems

public void onAjaxGetComboItems(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse resp)
                         throws OwException,
                                IOException

Throws:

OwException

IOException

processDataResponse

protected void processDataResponse(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse resp,
                       List<OwComboItem> items)
                            throws IOException

Throws:

IOException

isActiveContext

protected boolean isActiveContext()

(overridable) Verify if this instance should be active in current context/ field provider type.

Returns:

boolean true only if matching configuration, else false