Class icm.pgwidget.properties.dijit._Properties

Class that represents the Properties widget's internal implementation.
Defined in: <icm/pgwidget/properties/dijit/_Properties.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
icm.pgwidget.properties.dijit._Properties()

Method Summary

Method Attributes Method Name and Description
 
adjustDirtyState()
Adjusts the widget's dirty state.
 
bindController(editable)
Obtains a controller instance that is bound to the editable object.
 
closeView(callback)
Closes the view.
 
constructor()
Loads widget resource messages.
 
destroyRecursive()
Closes view to release all memory resources.
 
getComparator()
Gets the comparator function to be used for sorting the properties to be included in a system-generated view.
 
getFilter()
Gets the filter function to be used for filtering the properties to be included in a system-generated view.
 
getMarkup()
Gets the markup to be used for rendering the view.
 
getPropertyIds()
Gets the collection of property ids to be considered for inclusion in a system-generated view.
 
getRegistry()
Gets the widget registry used to render the view.
 
getResources()
Gets the resource bundle to be used for rendering the view.
 
getViewDefinitionId()
Gets the view definition id for the view to be rendered.
 
getViewDefinitionUrl()
Gets the view definition url for the view to be rendered.
 
openView(editable, options, callback)
Opens a view for the specified editable object with the specified options.
 
resize()
Resizes view dimension as needed.
 
setDirtyState(dirty)
Sets the widgets dirty state.
 
unbindController(controller)
Releases the binding of the controller.

Constructor Detail

icm.pgwidget.properties.dijit._Properties()

Method Detail

adjustDirtyState()

Adjusts the widget's dirty state.

This default implementation inspects both the controller and the view to determine the dirty state.

You may overload this function if required to support additional considerations of the dirty state.

bindController(editable)

Obtains a controller instance that is bound to the editable object.

This default implementation uses the ControllerManager to obtain a controller instance that is shared by other page widgets.

You may overload this method if required to bind an alternate controller instance.

Parameters:
editable
An editable model object that provides the properties to be displayed.
Returns:
A controller object used for binding the model and the view.

closeView(callback)

Closes the view.
Parameters:
callback
A callback function that is called after the view is closed.

constructor()

Loads widget resource messages.

destroyRecursive()

Closes view to release all memory resources.

getComparator()

Gets the comparator function to be used for sorting the properties to be included in a system-generated view.

This default implementation sorts the properties alphabetically by label with workgroup properties sorted to the top.

You may overload this method if required to provide an alternate comparator function.

The comparator function must return -1, 0 or 1 as required to indicate the sort order.

Returns:
The comparator function.

getFilter()

Gets the filter function to be used for filtering the properties to be included in a system-generated view.

This default implementation returns a filter function that excludes system defined, inherited and attachment properties.

You may overload this method if required to provide an alternate filter function.

Returns:
The filter function.

getMarkup()

Gets the markup to be used for rendering the view.

This default implementation returns null indicating that the markup should be retrieved from a view definition as specified by the getViewDefinitionId method.

You may overload this method if required to provide alternate markup for rendering the view. If your markup requires resource strings, you should also override the getResources method.

Returns:
The markup.

getPropertyIds()

Gets the collection of property ids to be considered for inclusion in a system-generated view.

This default implementation returns null indicating that all of the editable object's properties will be considered for inclusion.

You may overload this method if required to provide an alternate array of property ids.

Returns:
The array of property ids.

getRegistry()

Gets the widget registry used to render the view.

This default implementation returns the standard widget registry supported in IBM Case Manager.

You may overload this method if required to provide an alternate widget registry.

Returns:
The widget registry.

getResources()

Gets the resource bundle to be used for rendering the view.

This default implementation returns the resource bundle associated with the editable object's case type.

You may overload this method if required to provide an alternate resource bundle.

Returns:
The resource bundle.

getViewDefinitionId()

Gets the view definition id for the view to be rendered.

This default implementation returns the configured or default view definition id associated with the editable object's case type. A value of null indicates that the system-generated view should be rendered.

You may overload this method if required to provide an alternate view definition id.

This method will not be called if custom markup is provided by the icm.pgwidget.properties.dijit._Properties#getMarkup method.

Returns:
The view definition id.

getViewDefinitionUrl()

Gets the view definition url for the view to be rendered.

This default implementation returns the url associated with the configured or default view definition associated with the editable object's case type. A value of null indicates that the system-generated view should be rendered.

You may overload this method if required to provide an alternate view definition url.

This method will not be called if custom markup is provided by the icm.pgwidget.properties.dijit._Properties#getMarkup method.

Returns:
The view definition id.

openView(editable, options, callback)

Opens a view for the specified editable object with the specified options.
Parameters:
editable
An editable model object that provides the properties to be displayed.
options
The options to apply when loading the view.
  • readOnly: Indicates whether the view should be opened in read-only mode.
  • disabled: Indicates whether the view should be disabled when loaded.
  • applyDefaultValues: Indicates whether default values will be applied. 
 	Example: options = {
			disabled: true,
			applyDefaultValues: true
		};
callback
A callback function that is called after the view is opened.

resize()

Resizes view dimension as needed.

setDirtyState(dirty)

Sets the widgets dirty state.

This default implementation broadcasts the "icm.SetDirtyState" event.

You may overload this function if required to perform any other related operations.

Parameters:
dirty

unbindController(controller)

Releases the binding of the controller.

This default implementation uses the ControllerManager to release the controller instance that is shared by other page widgets.

You may overload this method if required to unbind the alternate controller instance obtained by your overloaded bindController method.

Parameters:
controller
The controller to unbind.