The classes in the ecm.widget package define widgets that you use to create and edit repository objects such as documents, folders, and work items. This package also includes classes that define common user interface components such as buttons, menus, and tabs.
| Widget class | Description |
|---|---|
| AddContentItemGeneralPane | Provides a pane that is used in the AddContentItemDialog widget to add a document or folder to a repository. This pane is also used in the CheckInDialog widget to check a document in to a repository. |
| AddContentItemPropertiesPane | Provides a pane that is used in the AddContentItemDialog widget to edit properties when a user adds a document or folder to the repository. This pane is also used in the CheckInDialog widget to edit properties when a user checks a document in to the repository. |
| AddContentItemSecurityPane | Provides a pane that is used in the AddContentItemDialog widget to view and edit the security settings of a document or folder that is being added to a repository. This pane is also used in the CheckInDialog widget to view and edit the security settings of a document or folder that is being checked in to a repository. |
| ChildComponentPropertiesPane | Provides a widget that is used to view and edit
the attributes of a child component of an IBM® Content
Manager item type. A child item type can have unique attributes. For example, IBM Content Collector uses child components to store email instance information and references to attributes of the distinct email item type. |
| ChildComponentSelector | Provides a widget that is used to display the child components of an IBM Content Manager item type. |
| CommonPropertiesPane | Provides a widget that is used to view and edit properties. This widget can be used in dialog boxes for adding documents, creating folders, and editing properties. |
| ContentClassSelector | Provides a widget that contains a tree or drop-down list that is used to select the class for a document or folder. |
| ContentListDropDownDialog | Provides a widget that contains a drop-down list that is used in a content list. |
| ContentListEditPane | Provides a widget that supports an edit properties pane for a single document. |
| FolderSelector | Provides a widget that is used to select folders in a repository, teamspace, or parent folder. |
| FolderSelectorCallback | Provides callback functions for the folder selector widget. |
| FoldersFiledInPane | Provides a widget that shows the folders in which a document is filed. |
| FolderTree | Provides a widget that is used to browse the folders in a repository. |
| ItemCommentsPane | Provides a widget that is used to view comments of or add comments to an item. Also provides controls to edit and delete accessible comments. |
| ItemEditPane | Provides a widget that is used to edit a folder or a document in a repository. |
| ItemNotelogsPane | Provides a widget that is used to view notelogs of or add notelogs to an item. Also provides controls to edit and delete accessible notelogs. |
| ItemPreviewPane | Provides a widget that displays a preview of the content for an item. |
| ItemPropertiesDisplayPane | Provides a widget the displays a read-only view of the properties for an item. |
| ItemPropertiesPane | Provides a widget that is used to edit the properties of an item. |
| ItemPropertiesPaneExtension | 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, which can contain custom properties for display and editing by the user. |
| ItemPropertiesStackPane | Provides a pane that contains a stack of ItemPropertiesPane widgets. Typically, the ItemPropertiesStackPane contains a single ItemPropertiesPane widgets. However, for reference attributes, a separate ItemPropertiesPane widget is added to the stack for each reference attribute the user opens. The user sees the top widget in the stack. |
| ItemSecurityPane | Provides a widget that contains the SecurityPane widget and is used by the Edit Properties dialog. This class retrieves the item permissions and other item information that is required by the SecurityPane widget to display the security information. |
| SecurityPane | Provides a widget that contains a list of users and roles that have access to an item. |
| UnselectableFolder | This class is used for folders that should not be selectable in the folder selector control. |
| VersionsPane | Provides a widget that is used to view the versions of an item. |
| Widget class | Description |
|---|---|
| TeamList | Provides a widget that displays a list of the users and groups that are assigned to a teamspace. |
| UserGroupSelector | Provides a widget that is used to select a user or group. This widget can be configured to display both users and groups or only users. The widget can also be configured to support multiple selections or only single selections. |
| UserGroupSelectorPane | Provides a pane that is used by the _PropertiesMixin class to select users or groups for assigning property value. The widget can be configured to display voting approval properties for Entry Template workflows. |
| Widget class | Description |
|---|---|
| _DroppedFilesAddDocMixin | Provides methods that are used to handle content class attributes. ContentClass and SearchContentClasses mixes in _DroppedFilesAddDocMixin. |
| _HoverHelpMixin | Provides a base class for creating and displaying hover help in the user interface. |
| _MoveUpDownGridxMixin | Provides a base class for a widget that is used to move items up or down in a gridx widget. |
| _MoveUpDownMixin | Provides a base class for a widget that is used to move items up or down in a list. |
| _SecurityMixin | Provides a base class that contains methods for working with IBM FileNet® P8 security data. |
| _Separator | Provides the separator that is used in the breadcrumb. |
| _SimpleBreadcrumb | Provides the data that is used in the breadcrumb. |
| _SinglePropertyEditorMixin | Provides a base class for a single property editor. |
| ActionMenu | Provides a widget that is used as a context menu. |
| Banner | Provides a banner that is displayed in the user interface for an IBM Content Navigator application. |
| BookmarkPane | Provides a widget that is provides a URL-addressable page that can display a bookmarked folder. The URL for the page can be created from the View Link action or the Email as Link action for a folder. |
| Breadcrumb | Provides a widget that displays the position of a user in the IBM Content Navigator application. |
| Button | Provides a widget that is used as a button in
the user interface. This class extends the Dojo dijit.form.Button class to provide hover help for the button. |
| CheckBox | Provides a check box that can be used to select
several values for the same property. This class extends the Dojo dijit.form.CheckBox class to provide hover help for the check box. |
| ComboBox | Provides a widget that displays a combination
box that consists of a field and a drop-down list. The user can select
a value from the list or type a value in the field. The value in the
field does not need to match a value in the list. This class extends the Dojo dijit.form.ComboBox class to provide hover help for the combination box. |
| CompositeButton | This widget provides a button that can be configured to display a button icon on the left of the container, a button title in the middle, or an action button icon on the right. This button is used by the SecurityPane widget to display item security entries. |
| DatePicker | Provides a widget that is used to select a date. This class extends the idx.form.DatePicker class to provide additional formatting patterns. |
| DesktopPane | Provides a widget that is used to display a desktop. |
| DownloadCount | Provides a widget that is used to display the download count property for a document, including a control to retrieve and display the list of users that have downloaded the document. |
| DropDownButton | Extension to dijit.form.DropDownButton to add the idxDropDownOpen CSS class whenever the DropDownButton object is opened. This allows for alternate styling on the widget when its drop-down is in the open state. This is included with idx.ext. |
| DropDownDialog | Provides a widget that is used to display a drop-down list. |
| DropDownInput | Provides a widget that combines a drop-down list and a field. A user can enter a value in the field or select a value from the drop-down list. |
| DropDownLink | Provides a widget that contains a link with a drop-down menu and summary. |
| Ellipsis | Provides a widget that displays an ellipsis (…) to indicate that data is truncated so the user is not seeing all the values. The widget can be configured to truncate data on the left or on the right. By default, data is truncated on the right. |
| FavoritesTree | Provides a widget that contains a tree that is used to display the user’s favorites. |
| FilteringSelect | Provides a combination box that consists of
a drop-down list and a field. The user can select a value from the
list or type a value in the field. The list is filtered to display
values that begin with the value entered in the field. A valid entry
must match completely a value from the list. This class extends the Dojo dijit.form.FilteringSelect class to support hover help. |
| FilterTextBox | Provides a widget that is used to filter the input in a text box. |
| GlobalToolbar | Provides a widget that is used as a global toolbar for an IBM Content Navigator application. |
| HoverHelp | Provides a widget that is used to display the question mark icon that links to help in the user interface. |
| HoverHelpText | Provides a widget that is used to display hover help and text in a grid cell in the user interface. |
| LoginPane | Provides a widget that is used to log in to a content management server. This widget prompts the user for credentials to authenticate to the server. |
| MessageBar | Provides a widget that is used as a message bar in an IBM Content Navigator application. |
| MultiColumnList | Provides a simple multiple-column list that is used to select items. |
| MultiValueChoicePane | Provides a widget that is used to select multiple values from a choice list. This widget is used for IBM FileNet Content Manager repositories. |
| MultiValueInputPane | Provides a widget that is used to enter multiple values. This widget is used for IBM FileNet Content Manager repositories. |
| NumberSpinner | Provides a widget that contains a text box that is used to enter a numeric value. This class extends the Dojo dijit.form.NumberSpinner class to support hover help. |
| NumberTextBox | Provides a widget that contains a text box that
is used to enter a numeric value. This class extends the Dojo dijit.form.NumberTextBox class to support hover help. |
| PropertyEditors | Provides a widget that holds form fields in a private array variable. |
| RadioButton | Provides a widget that contains a set of choices
from which only one can be selected. This class extends the Dojo dijit.form.RadioButton class to support hover help. |
| RangeBoundTextBox | Provides a widget that contains a text box for
which a range of valid values is specified. This class extends the Dojo dijit.form.RangeBoundTextBox class to support range checking for large exponents. |
| ReferenceAttributeButton | Provides a widget that is used as a button to display a the object identified by a reference attribute in an IBM Content Manager repository. |
| RepositorySelector | Provides a widget that is used to select a repository. |
| Select | Provides a widget that is used as a button that
displays a drop-down list when it is clicked. This class extends the Dojo dijit.form.DropDownButton to provide hover help for the button. |
| SelectObject | Provides a widget that is used to select a repository object by entering a query. |
| ShowHyperlinkPane | Provides a widget that is used to display the hyperlink for a document or folder. |
| SinglePropertyEditorFactory | Provides a factory that creates a SinglePropertyEditor instance. |
| SingleSelectTree | Provides a widget that contains a tree in which the user can select one node in the tree at a time. |
| SingleValueTreePane | Provides a widget that contains a tree in which the user can select one value at a time. This widget is used for IBM FileNet Content Manager object stores. |
| SloshBucket | Provides a widget that is used to pick a subset
of unique items from a larger set of items. The widget contains two single column lists. One list contains the available items and the other list contains the selected items. The Add button and a Remove button that are used to move items from one list to the other appear between the columns. Optionally, the widget includes an Up button and a Down button that are used to order the selected items. |
| StandByDropDownInput | Provides a widget that combines a drop-down list and a field. A user can enter a value in the field or select a value from the drop-down list. It also hooks up the stand by status when the drop-down pane is waiting for query data. |
| StateSelect | Provides a widget that contains a drop-down selection box. This class extends the Dojo dijit.form.Select class to support options that can be set programmatically for the selection box, but that are hidden from users. |
| TextBox | Provides a widget that contains a text box. This class extends the Dojo dijit.form.TextBox class to provide hover help for the text box. |
| TimePicker | Provides a widget that is used to select a time. This class extends the idx.form.TimePicker class to provide additional formatting patterns. |
| TitlePane | Provides a widget that contains a content box
with a title. This widget can be opened or collapsed. This class extends the idx.layout.TitlePane class to provide hover help for the widget. |
| Tree | A custom version of dijit.Tree that is used within the IBM Content Navigator widgets. |
| TreeDndSource | Provides a widget that contains a tree that is used to navigate the folders in a repository. This widget extends the Dojo dijit.tree.dndSource class to prevent users from using the drag-and-drop feature to move the More node. (The More node is shown in a tree when more results exist. The additional results are displayed with the user clicks this node.) |
| TreeSelector | Provides a widget that contains a tree that is used to navigate the folders in a repository. This widget allows users to select multiple folders, but it does not allow them to select nodes with no item value. |
| TreeSloshBucket | Provides a widget that contains a slosh bucket that uses a tree to display available and selected items. |
| ValidationTextarea | Provides a widget that contains a text area in which the user input is validated against the specified criterion. This class extends ecm.widget.ValidationTextBox and the Dojo dijit.form.SimpleTextarea class to add validation. |
| ValidationTextBox | Provides a widget that contains a text box in
which the user input is validated against the specified criterion. This class extends the Dojo dijit.form.ValidationTextBox class to add validation for byte maximum length. |
| VerticalSloshBucket | Provides a vertical slosh bucket that is used in teamspace builder to add classes or entry templates, searches, and existing roles to teamspace templates. |
| Widget class | Description |
|---|---|
| TeamspacePropertiesPane | Provides a widget that is used to view or edit the properties of a teamspace template. |
| Widget class | Description |
|---|---|
| StartWorkflow | Provides a widget that is used to start folders and documents on a workflow. |
| SuspendWorkItems | Provides a widget that is used to suspend folders and documents on a workflow. |
| WorklistSelector | Provides a widget that contains a tree that is used to navigate process workflow items. This widget displays the available work lists, process roles, and in-baskets for selection. |