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
	pvr.widget._Property()

Field Summary

Field Attributes	Field Name and Description
	binding The binding reference for the associated pvr.controller._PropertyController.
	collectionController The property collection controller.
	container The container.
	controller The property controller.
	defaultValue The configured default value setting.
	editor The configured editor class path.
	editorConfig The editor configuration.
	editorParams The configured editor parameters.
	editorWidget The editor widget.
	help The configured help message.
	hidden The configured hidden setting.
	innerEditor The configured inner editor class path.
	innerEditorConfig The inner editor configuration.
	innerEditorParams The configured inner editor parameters.
	label The configured label.
	lateBound Indicates that the property is late-bound.
	lateBoundType Indicates that the property is late-bound and its type.
	multiEditor The configured multi editor class path.
	multiEditorParams The configured multi editor parameters.
	readOnly The configured read-only setting.
	required The configured required setting.
	view The view.

Method Summary

Method Attributes	Method Name and Description
	buildRendering()
	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.
	computeInnerEditorParamName(name) Computes the specified parameter name for the inner editor.
	computeInnerEditorParams() Computes the parameters for the inner editor.
	computeInnerEditorParamValue(name) Computes the specified parameter value for the inner editor.
	destroyRecursive()
	get(name) Overridden to pass any additional arguments to the getter method.
	isModified() 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.
	postCreate()
	resetModified() Reset the modified state.

Constructor Detail

pvr.widget._Property()

Field Detail

binding

The binding reference for the associated pvr.controller._PropertyController.

Consists of the concatenation of the collection identifier and the property identifier with a period for a delimiter.

{object} collectionController

The property collection controller.

{object} container

The container.

{object} controller

The property controller.

defaultValue

The configured default value setting.

editor

The configured editor class path.

{object} editorConfig

The editor configuration.

editorParams

The configured editor parameters.

{object} editorWidget

The editor widget.

help

The configured help message.

hidden

The configured hidden setting.

innerEditor

The configured inner editor class path.

{object} innerEditorConfig

The inner editor configuration.

innerEditorParams

The configured inner editor parameters.

label

The configured label.

lateBound

Indicates that the property is late-bound.

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

Indicates that the property is late-bound and its type.

The model object for late-bound properties does not exist in the view designer, but is expected to be present at run time.

multiEditor

The configured multi editor class path.

Legacy view definitions which support this setting are converted to use the innerEditor setting instead.

multiEditorParams

The configured multi editor parameters.

Legacy view definitions which support this setting are converted to use the innerEditorParams setting instead.

readOnly

The configured read-only setting.

required

The configured required setting.

{object} view

The view.

Method Detail

buildRendering()

computeEditorParamName(name)

Computes the specified parameter name for the editor.

Parameters:
name: The setting name.

Returns:: The parameter name.

computeEditorParams(includeValueParams)

Computes the parameters for the editor.

Parameters:
includeValueParams: Indicates whether the value and error parameters should be included.

Returns:: The parameters for the editor.

computeEditorParamValue(name)

Computes the specified parameter value for the editor.

Parameters:
name: The setting name.

Returns:: The parameter value.

computeInnerEditorParamName(name)

Computes the specified parameter name for the inner editor.

Parameters:
name: The setting name.

Returns:: The parameter name.

computeInnerEditorParams()

Computes the parameters for the inner editor.

Returns:: The parameters for the inner editor.

computeInnerEditorParamValue(name)

Computes the specified parameter value for the inner editor.

Parameters:
name: The setting name.

Returns:: The parameter value.

destroyRecursive()

get(name)

Overridden to pass any additional arguments to the getter method.

Parameters:
name: The property to get.

Returns:: The property value.

isModified()

Indicates whether value was modified.

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)

Indicates whether the specified setting is supported as an editor parameter.

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)

Indicates whether the specified setting is supported as an inner editor parameter.

Parameters:
name: The setting name.
includeValueParams

Returns:: true if the setting is supported.

isValid()

Indicates whether the property value meets the validation constraints defined by its settings.

Returns:: true if the property value is valid; otherwise returns false.

layout()

onChange(value, error)

Event fired when this property's value changes.

Parameters:
value: The new value.
error: The error.

postCreate()

resetModified()

Reset the modified state.