Class ecm.widget.ItemPropertiesPaneExtension
Extends
dijit._Widget.
Provides a widget that is used to extend the ItemPropertiesPane
. The extension can add a
new section, similar to the Properties and System Properties sections, that can contain custom properties
for display and editing by the user.
Defined in: <ecm\widget\ItemPropertiesPaneExtension.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Method Summary
Method Attributes | Method Name and Description |
---|---|
isEnabledFor(item)
Overridden to indicate that the provided item is one that has properties of the type to be displayed by this
extension.
|
|
isValid()
This function is invoked prior to saving to determine if a value is not valid.
|
|
onChange()
This is an event that should be invoked by the extension whenever a property field has changed.
|
|
saveIntoProperties(properties)
This function is invoked during save.
|
|
setItem(item)
Specifies the item whose custom properties are to be displayed.
|
Method Detail
isEnabledFor(item)
Overridden to indicate that the provided item is one that has properties of the type to be displayed by this
extension. If
true
is returned, the extension's section will be added to the properties pane.
- Parameters:
- item
{Boolean} isValid()
This function is invoked prior to saving to determine if a value is not valid. It allows the extension to
disable the saving of properties if a property on the extension is invalid.
- Returns:
- {Boolean} A value of
true
if the fields are all valid,false
otherwise.
onChange()
This is an event that should be invoked by the extension whenever a property field has changed. The
containing property editor will listen to this event and enable save when appropriate (when all fields are
valid).
saveIntoProperties(properties)
This function is invoked during save. It is passed the JSON representation of the properties for the item as
will be saved. It allows the extension to change these properties or add new properties which will be sent to
the server. Note: If new properties are provided, the plug-in that is providing the
extension might need to additionally provide a custom filter to respond to the additional properties and
provide the appropriate actions on the server to save the properties.
- Parameters:
- properties
setItem(item)
Specifies the item whose custom properties are to be displayed.
- Parameters:
- item