Class pvr.widget._Property
Extends
dijit/layout/_LayoutWidget.
Provides the base class for a property object in the view.
Defined in: <pvr\widget\_Property.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The binding reference for the associated pvr.controller._PropertyController.
|
|
The property collection controller.
|
|
The container.
|
|
The property controller.
|
|
The configured default value setting.
|
|
The configured editor class path.
|
|
The editor configuration.
|
|
The configured editor parameters.
|
|
The editor widget.
|
|
The configured help message.
|
|
The configured hidden setting.
|
|
The configured inner editor class path.
|
|
The inner editor configuration.
|
|
The configured inner editor parameters.
|
|
The configured label.
|
|
Indicates that the property is late-bound.
|
|
Indicates that the property is late-bound and its type.
|
|
The configured multi editor class path.
|
|
The configured multi editor parameters.
|
|
The configured read-only setting.
|
|
The configured required setting.
|
|
The view.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
computeEditorParamName(name)
Computes the specified parameter name for the editor.
|
|
computeEditorParams(includeValueParams)
Computes the parameters for the editor.
|
|
computeEditorParamValue(name)
Computes the specified parameter value for the editor.
|
|
Computes the specified parameter name for the inner editor.
|
|
Computes the parameters for the inner editor.
|
|
Computes the specified parameter value for the inner editor.
|
|
get(name)
Overridden to pass any additional arguments to the getter method.
|
|
Indicates whether value was modified.
|
|
isSupportedEditorParam(name, includeValueParams)
Indicates whether the specified setting is supported as an editor parameter.
|
|
isSupportedInnerEditorParam(name, includeValueParams)
Indicates whether the specified setting is supported as an inner editor parameter.
|
|
isValid()
Indicates whether the property value meets the validation constraints defined by its settings.
|
|
layout()
|
|
onChange(value, error)
Event fired when this property's value changes.
|
|
Reset the modified state.
|
Field Detail
binding
Consists of the concatenation of the collection identifier and the property identifier with a period for a delimiter.
{object} collectionController
{object} container
{object} controller
defaultValue
editor
{object} editorConfig
editorParams
{object} editorWidget
help
hidden
innerEditor
{object} innerEditorConfig
innerEditorParams
label
lateBound
Legacy view definitions did not differentiate the type of late-bound properties. Legacy view definitions are converted to use the lateBoundType setting instead. The type is determined by the legacySettings member of the view settings.
lateBoundType
The model object for late-bound properties does not exist in the view designer, but is expected to be present at run time.
multiEditor
Legacy view definitions which support this setting are converted to use the innerEditor setting instead.
multiEditorParams
Legacy view definitions which support this setting are converted to use the innerEditorParams setting instead.
readOnly
required
{object} view
Method Detail
buildRendering()
computeEditorParamName(name)
- Parameters:
- name
- The setting name.
- Returns:
- The parameter name.
computeEditorParams(includeValueParams)
- Parameters:
- includeValueParams
- Indicates whether the value and error parameters should be included.
- Returns:
- The parameters for the editor.
computeEditorParamValue(name)
- Parameters:
- name
- The setting name.
- Returns:
- The parameter value.
computeInnerEditorParamName(name)
- Parameters:
- name
- The setting name.
- Returns:
- The parameter name.
computeInnerEditorParams()
- Returns:
- The parameters for the inner editor.
computeInnerEditorParamValue(name)
- Parameters:
- name
- The setting name.
- Returns:
- The parameter value.
destroyRecursive()
get(name)
- Parameters:
- name
- The property to get.
- Returns:
- The property value.
isModified()
Returns true even if the new value was not committed to the controller because of invalid data.
- Returns:
- true if the property's value was modified.
isSupportedEditorParam(name, includeValueParams)
- Parameters:
- name
- The setting name.
- includeValueParams
- Indicates whether the "value" and "error" settings are supported in this context.
- Returns:
- true if the setting is supported.
isSupportedInnerEditorParam(name, includeValueParams)
- Parameters:
- name
- The setting name.
- includeValueParams
- Returns:
- true if the setting is supported.
isValid()
- Returns:
- true if the property value is valid; otherwise returns false.
layout()
onChange(value, error)
- Parameters:
- value
- The new value.
- error
- The error.