Class ecm.model.Feature

Extends ecm.model._ModelObject.
Represents a major feature that can be configured for a desktop. This feature can be displayed with the features that are provided by IBM Content Navigator such as favorites, browse, search, and administration.
Private functions should not be used to access public members of the class. Access member variables directly. For example:

var feature = new Feature({ id: "favorites", featureClass: "ecm.widget.layout.FavoritesPane", iconUrl: "favoritesLaunchIcon" });
console.debug("Feature class=" + feature.featureClass);

Note: Private getter methods, such as getFeatureClass, will be removed in a future release.
Defined in: <ecm\model\Feature.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Feature(properties) Constructs a feature.

Field Summary

Field Attributes	Field Name and Description
	configurations Configuration settings for this feature.
	featureClass The name of a widget class implementing the feature.
	featureTooltip The tooltip to display when the user hovers over the feature's icon.
	iconUrl A URL to the icon image resource representing the feature.
	pluginConfiguration Custom configurations provided by the plug-in for this feature.
	popupWindowClass The name of a widget class implementing the popup window for the feature.
	popupWindowTooltip The tooltip to display for the popup window.
	preLoad A boolean indicating that the features widgets should be constructed during the initialization of the layout for the desktop.
	separator A boolean indicating that this 'feature' is actually a separator.

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.Feature(properties)

Constructs a feature. Note that features are normally constructed as part of ecm.model.Desktop.loadDesktop and don't need to be constructed separately.

Parameters:
properties: The properties of the feature. The properties can be any of the public fields as defined below and in ecm.model._ModelObject.

Field Detail

configurations

Configuration settings for this feature.

Since:: 2.0.3

featureClass

The name of a widget class implementing the feature.

featureTooltip

The tooltip to display when the user hovers over the feature's icon.

iconUrl

A URL to the icon image resource representing the feature.

pluginConfiguration

Custom configurations provided by the plug-in for this feature. Plug-in writers can set values here by using PluginServiceCallbacks.saveFeatureConfiguration() or providing a ecm.widget.admin.PluginConfigurationPane for user's input.

Since:: 2.0.3

popupWindowClass

The name of a widget class implementing the popup window for the feature.

popupWindowTooltip

The tooltip to display for the popup window.

preLoad

A boolean indicating that the features widgets should be constructed during the initialization of the layout for the desktop. If false then the features widgets will not be constructed until the user selects to use the feature.

separator

A boolean indicating that this 'feature' is actually a separator.