public abstract class OwFieldManagerControl extends OwEventTarget
Base Class for field manager UI Controls.
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
Constructor and Description |
---|
OwFieldManagerControl() |
Modifier and Type | Method and Description |
---|---|
OwFieldManager |
getFieldManager() |
String |
getFormEventFunction(String eventName,
String additionalParameters,
boolean disableValidation)
Create a script function the same way like
OwEventTarget.getFormEventFunction(String, String) ,
but allow to control if form-validation is active or not. |
String |
getFormEventURL(String eventName,
String additionalParameters,
boolean disableValidation)
Creates an URL the same way like the
OwEventTarget.getFormEventFunction(String, String) ,
but allow also to dis-/enable validation of form values. |
String |
getFormName()
Get the form used for the edit fields.
By default return null, should be overridden by derived classes |
OwEventTarget |
getFormTarget()
get the target, that is used for form date and renders form
|
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
|
abstract void |
insertEditField(Writer w_p,
OwFieldDefinition fieldDef_p,
OwField field_p,
String strID_p)
format and displays the value attached to the fieldClass in HTML for use in a HTML Form.
|
void |
insertLabel(Writer w_p,
String suffix_p,
OwField field,
String strID_p,
boolean writeLabel_p)
Renders a property control label on the given Writer.
value type are considered at rendering time. |
abstract void |
insertReadOnlyField(Writer w_p,
OwFieldDefinition fieldDef_p,
Object value_p)
format and displays the value attached to the PropertyClass in HTML
|
abstract 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.
|
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
public void init(OwFieldManager fieldmanager_p, Node configNode_p) throws Exception
fieldmanager_p
- OwFieldManager reference to the field manager containing the field controlconfigNode_p
- DOM Node to the configuration XML for the control, or null to use defaultsException
protected void init() throws Exception
OwEventTarget
init
in class OwEventTarget
Exception
public OwFieldManager getFieldManager()
public OwEventTarget getFormTarget()
getFormTarget
in class OwEventTarget
public String getFormName()
OwEventTarget
getFormName
in class OwEventTarget
public String getFormEventURL(String eventName, String additionalParameters, boolean disableValidation)
OwEventTarget.getFormEventFunction(String, String)
,
but allow also to dis-/enable validation of form values.eventName
- StringadditionalParameters
- String (can be null)disableValidation
- booleanpublic String getFormEventFunction(String eventName, String additionalParameters, boolean disableValidation)
OwEventTarget.getFormEventFunction(String, String)
,
but allow to control if form-validation is active or not.eventName
- StringadditionalParameters
- String (can be null)disableValidation
- boolean flagpublic abstract void insertReadOnlyField(Writer w_p, OwFieldDefinition fieldDef_p, Object value_p) throws Exception
w_p
- Writer object to write HTML tofieldDef_p
- OwFieldDefinition definition of fieldvalue_p
- Object Value to be displayedException
public abstract void insertEditField(Writer w_p, OwFieldDefinition fieldDef_p, OwField field_p, String strID_p) throws Exception
w_p
- Writer object to write HTML tofieldDef_p
- OwFieldDefinitionfield_p
- OwField Value to be displayedstrID_p
- ID of the HTML elementException
public abstract Object updateField(javax.servlet.http.HttpServletRequest request_p, OwFieldDefinition fieldDef_p, Object value_p, String strID_p) throws Exception
request_p
- HttpServletRequestfieldDef_p
- OwFieldDefinitionvalue_p
- Object old ValuestrID_p
- ID of the HTML elementException
public void insertLabel(Writer w_p, String suffix_p, OwField field, String strID_p, boolean writeLabel_p) throws Exception
w_p
- suffix_p
- field
- strID_p
- writeLabel_p
- Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.