Wdk Reference Guide 6.0 Sp1

EMC® Documentum® Web Development Kit and Webtop Version 6 SP1

Reference Guide P/N 300-006-180 A01

EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com

Copyright © 2002 - 2007 EMC Corporation. All rights reserved. Published December 2007 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

Table of Contents

Preface Chapter 1

................................................................................................................................ 11 Controls Reference ..................................................................................... Common control attributes ........................................................................... Event attributes ............................................................................................ Action attributes ........................................................................................... Dynamic action attribute values .................................................................... Runtime tag attribute override ...................................................................... Actions ............................................................................................................

13 13 15 15 16 17 17

Attributes ........................................................................................................ Client browser detection ...................................................................................

36 61

Collaboration ................................................................................................... 64 Context ............................................................................................................ 94 Data display ..................................................................................................... 95 Data validation ............................................................................................... 131 Date/time ....................................................................................................... Deprecated controls ........................................................................................ Drag and drop................................................................................................ Explorer ......................................................................................................... Framework .................................................................................................... Generating client and server events ................................................................. Grouping user interface elements ....................................................................

156 164 164 168 168 170 174

HTML ........................................................................................................... Imaging Services ............................................................................................ Including components .................................................................................... Including other pages ..................................................................................... Internal use only............................................................................................. Links ............................................................................................................. Media and transformation ............................................................................... Menu grouping ..............................................................................................

185 222 233 234 237 238 244 248

Navigational aids ........................................................................................... Object and file selection .................................................................................. Output formatting .......................................................................................... Passing arguments .......................................................................................... Passwords ......................................................................................................

256 265 270 282 285

Preferences..................................................................................................... Repositories ................................................................................................... Search ............................................................................................................

287 296 310

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

3

Table of Contents

Chapter 2

4

Text display and input .................................................................................... Trees .............................................................................................................. User feedback.................................................................................................

342 349 355

Virtual documents .......................................................................................... Web Workflow Manager ................................................................................. Workflow ....................................................................................................... xForms ..........................................................................................................

362 366 367 372

Actions Reference ..................................................................................... Overview ....................................................................................................... Common elements .......................................................................................... failoverenabled........................................................................................... reverse-precondition ................................................................................... Application connectors ................................................................................... Application management ................................................................................ Attributes ...................................................................................................... Cabinets and folders .......................................................................................

375 375 375 375 375 376 381 388 403

Categories ...................................................................................................... Clipboard operations ...................................................................................... Collaboration ................................................................................................. Creating objects .............................................................................................. Data export .................................................................................................... Downloading and uploading content ............................................................... Emailing links to objects.................................................................................. Formats .........................................................................................................

407 408 416 452 453 454 495 498

General user interface ..................................................................................... Imaging Services ............................................................................................ Jobs ............................................................................................................... Lifecycles ....................................................................................................... Locating objects ..............................................................................................

500 503 504 507 512

Media and transformation ............................................................................... Navigational aids ........................................................................................... Notifications .................................................................................................. Physical Records Manager .............................................................................. Preferences..................................................................................................... Presets ........................................................................................................... Records Manager............................................................................................

519 524 525 529 533 536 546

Relationships between objects ......................................................................... Renditions...................................................................................................... Replicas and References .................................................................................. Repository ..................................................................................................... Search ............................................................................................................

551 553 561 562 565

Security ......................................................................................................... Subscriptions .................................................................................................

588 606

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Table of Contents

Chapter 3

Testing ........................................................................................................... User feedback................................................................................................. Users, groups, and roles ..................................................................................

609 617 618

Virtual documents .......................................................................................... Workflows ..................................................................................................... Work queue management ............................................................................... XForms ..........................................................................................................

645 681 746 792

Components Reference ............................................................................. Overview ....................................................................................................... Common elements .......................................................................................... actiontable ................................................................................................. allversionsvisible ........................................................................................ asynchronous ............................................................................................. attributes ................................................................................................... autogettaskdefault ...................................................................................... base_type ................................................................................................... bindingcomponentversion .......................................................................... breadcrumbiconwellmode........................................................................... cabinets...................................................................................................... category ..................................................................................................... clientevent ................................................................................................. columns (for data columns) ......................................................................... columns (for streamline view) ..................................................................... columns_list ............................................................................................... columns_all_saved_searches ....................................................................... columns_drilldown .................................................................................... columns_my_saved_searches ...................................................................... columns_saved_search ................................................................................ comments .................................................................................................. commitorder .............................................................................................. containerselectable ..................................................................................... contenttypepanelvisible .............................................................................. cost_attribute_conditions ............................................................................ default_binding_filter_values ...................................................................... default_type ............................................................................................... defaultaccounts .......................................................................................... defaultsources ............................................................................................ defaultview ................................................................................................ displayresultspath ...................................................................................... docbase-type-mappings .............................................................................. document-docbase-base-type ...................................................................... document-docbase-type .............................................................................. document_filter .......................................................................................... dragdrop ................................................................................................... duration_attribute_conditions ..................................................................... enableShowAll ........................................................................................... entrypage................................................................................................... failoverenabled........................................................................................... filenamefiltervisible .................................................................................... filter........................................................................................................... flatlist ........................................................................................................ folder-docbase-type .................................................................................... folder_filter ................................................................................................ formsavefolderpath .................................................................................... header .......................................................................................................

795 795 795 795 795 795 796 796 796 796 796 797 797 797 797 797 798 798 799 799 800 800 801 801 801 801 802 802 802 803 803 803 803 804 804 804 804 805 805 805 806 806 806 806 806 806 807 807

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

5

Table of Contents

help-entries ................................................................................................ helppath .................................................................................................... hideEvents ................................................................................................. highlight_matching_terms .......................................................................... homeURL .................................................................................................. homecabinet ............................................................................................... iconwell_icon ............................................................................................. inbox ......................................................................................................... includetypes............................................................................................... includeunlisted .......................................................................................... init-controls................................................................................................ isIgnorePrefRenditions ............................................................................... locator ....................................................................................................... lockInstance ............................................................................................... map ........................................................................................................... maxidletime ............................................................................................... menugrouptarget ....................................................................................... modifiedwithindays ................................................................................... multidocbasesupport .................................................................................. myobjects ................................................................................................... navigationlinks........................................................................................... newcomponentname .................................................................................. nodes ......................................................................................................... nomaclsupport ........................................................................................... nondocbasecolumns ................................................................................... numberedtabs ............................................................................................ objectfilters ................................................................................................ pageTitle .................................................................................................... permissionsservice ..................................................................................... preferencedisplaygroups ............................................................................. preferences................................................................................................. preserve-file-extension ................................................................................ preset_item ................................................................................................ preset_item_definition ................................................................................ preset_scope_definitions ............................................................................. privatecabinet_visible ................................................................................. privatecabinetvisible ................................................................................... privategroupvisible .................................................................................... readOnly.................................................................................................... savedetailsreport ........................................................................................ search_types .............................................................................................. searchtypes ................................................................................................ selectedattribute ......................................................................................... serveroptionenabled ................................................................................... service ....................................................................................................... setrepositoryfromobjectid ........................................................................... showattachmentinfo ................................................................................... showautogettask ........................................................................................ showbreadcrumb ....................................................................................... showfilters ................................................................................................. showfolderpath .......................................................................................... showfolders ............................................................................................... showheaderforsinglepackage ...................................................................... showjobstatus ............................................................................................ showoptions............................................................................................... showpagesastabs ........................................................................................ showusertimeandcost ................................................................................. skipVersionCheck ....................................................................................... startComp ..................................................................................................

6

807 807 808 808 808 808 808 809 809 809 809 810 810 810 810 810 811 811 811 811 811 811 812 812 813 813 813 814 814 814 814 816 816 817 817 818 818 818 818 818 818 819 820 820 820 820 820 821 821 821 821 821 821 822 822 822 822 822 822

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Table of Contents

startQueryString ......................................................................................... subscriptions .............................................................................................. taskmgractionname .................................................................................... taskmanagerid ........................................................................................... transformation ........................................................................................... type ........................................................................................................... ucfrequired ................................................................................................ updatereplicasource ................................................................................... useronly..................................................................................................... useroptions ................................................................................................ views ......................................................................................................... windowparams .......................................................................................... workflowstatusactionname ......................................................................... workqueuegroupvisible .............................................................................. Actions ..........................................................................................................

823 823 823 823 823 824 824 824 824 825 825 827 827 827 827

Administration ...............................................................................................

828

Application connectors ................................................................................... 831 Application management ................................................................................ 868 Attributes ...................................................................................................... 897 Cabinets and folders ....................................................................................... 934 Categories ...................................................................................................... 945 Clipboard operations ...................................................................................... 961 Collaboration ................................................................................................. 964 Creating objects ............................................................................................ 1044 Data import and export ................................................................................. Displaying lists of objects .............................................................................. Displaying lists of objects associated with an object......................................... Downloading and uploading content ............................................................. Emailing object links .....................................................................................

1049 1052 1080 1083 1147

Formats ....................................................................................................... General user interface ................................................................................... Helpers ........................................................................................................ Home Cabinet .............................................................................................. Imaging Services .......................................................................................... Inbox ........................................................................................................... Jobs .............................................................................................................

1154 1158 1179 1181 1192 1200 1204

Lifecycles ..................................................................................................... Locating objects ............................................................................................ Media and transformation ............................................................................. Menus ......................................................................................................... My Files .......................................................................................................

1208 1219 1220 1231 1234

Physical Records Manager ............................................................................ Preferences................................................................................................... Presets ......................................................................................................... Records Manager.......................................................................................... Relationships between objects ....................................................................... Renditions....................................................................................................

1241 1249 1266 1292 1325 1329

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

7

Table of Contents

Repository ................................................................................................... Retention Policy Services............................................................................... Search ..........................................................................................................

1331 1336 1337

Security ....................................................................................................... Subscriptions ............................................................................................... Task manager ............................................................................................... Testing ......................................................................................................... Trees ............................................................................................................ User feedback............................................................................................... Users, groups, and roles ................................................................................

1379 1400 1411 1414 1459 1465 1477

Virtual document assemblies ......................................................................... Virtual documents ........................................................................................ Workflow reporting ...................................................................................... Workflows ................................................................................................... Work queue management ............................................................................. XForms ........................................................................................................

1515 1523 1547 1580 1673 1737

Appendix A

Version 6.0: New Controls, Actions, and Components ............................ Controls ....................................................................................................... Actions ........................................................................................................ Components.................................................................................................

1751 1751 1752 1754

Appendix B

Version 6.0 SP1: New Controls, Actions, and Components .................... Controls ....................................................................................................... Actions ........................................................................................................ Components.................................................................................................

1759 1759 1759 1759

8

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Table of Contents

List of Figures

Figure 1. Figure 2.

In-progress real-time search monitoring ............................................................. Completed real-time search monitoring .............................................................

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

1367 1368

9

Table of Contents

List of Tables

Table 1. Table 2. Table 3.

Common control attributes ................................................................................... Event attributes .................................................................................................... Common action control attributes ..........................................................................

14 15 16

Table 4. Table 5. Table 6. Table 7. Table 8. Table 9. Table 10.

Rich text configuration elements ............................................................................ Rich text configuration elements ............................................................................ Rich text editor configuration elements (<editor>) ................................................... Row selection settings ......................................................................................... Valid Mask Characters ........................................................................................ Global date input control configuration elements .................................................. Global datetime control configuration elements ....................................................

77 83 84 104 143 158 162

Table 11.

Global datetime control configuration elements ....................................................

164

Table 12.

Image Viewer Control Parameters .......................................................................

230

10

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Preface

This reference manual is part of the documentation set for the Documentum Web Development Kit (WDK) and Webtop. Other materials related to WDK are: •

Web Development Kit Development Guide

•

Webtop Development Guide

•

Web Development Kit and Applications Tutorial

•

Javadocs for WDK, Webtop, and Documentum Foundation Classes (DFC)

The Documentum developer Web site, developer.documentum.com, provides sample code, tips, white papers, and a wealth of information to assist you in developing Documentum-enabled applications. This guide is intended for two tasks: •

Configuration Changes to XML files or modifications of JSP pages to configure controls on the page. Does not require a developer license.

•

Customization Extending WDK classes or modifying the JSP pages to include new functionality. Requires a developer license.

Revision history The following changes have been made to this document:

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

11

Preface

Revision History

Revision Date

Description

December 2007

Updated for Documentum 6 SP1, including worfklow business calendar and preset migration. Also contains minor corrections to version 6.

12

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Chapter 1 Controls Reference Overview Controls are grouped according to how they are used. The configurable attributes for WDK controls are documented in this section. Control attributes are configured in the JSP page. For examples of the usage and configuration of the individual WDK , see the JSP pages in the WDK and WDK client products such as Webtop and Web Publisher. For information about controls specific to a WDK client product, see the development guide for that product. The following topics describe attributes that are common to groups of controls: •

Common control attributes, page 13

•

Event attributes, page 15

•

Action attributes, page 15

•

Dynamic action attribute values, page 16

•

Runtime tag attribute override, page 17

Portlet component controls are documented in WDK for Portlets Development Guide.

Common control attributes The following attributes are defined by the ControlTag class and can be set on any control. Some of these attributes may not be used by the tag classes in the rendering of the control, however. For the exact list of all attributes that are supported by a tag class, see the tag library. Event attributes such as runatclient, onchange, onselect, or onclick, are documented in Event attributes, page 15. The table below describes attributes that are common to most controls. If a common attribute requires a value for a particular control, that requirement is noted in the control description.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

13

Controls Reference

Table 1. Common control attributes

Attribute

Description

cssclass

Sets the CSS class that is applied to the control.

enabled

Sets whether the control is enabled.

focus

True to allow the control to accept focus.

id

ID for the control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

Contains a string value or element that maps to a string label that is displayed in the user interface.

name

Sets the name for the control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

NLS lookup key. The string corresponding to the NLS ID is substituted for another attribute in the control. See the individual control descriptions for the attribute whose value is substituted by nlsid.

style

A CSS rule enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tooltip

String displayed when you place the mouse pointer over this control.

tooltipnlsid

NLS key to use when looking up a localized tooltip string.

tooltipdatafield

Datafield that overrides the value of tooltip and tooltipnlsid.

visible

(Boolean) Whether the control is rendered as visible (True) or hidden (False). Some controls do not implement visibility.

14

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

Controls Reference

Event attributes Many controls accept user input. The user input is submitted by a control event. The value of the event attribute corresponds to the name of an event handler. The event is generally handled in the calling component class unless the control has the runatclient attribute set to true. To find the exact event attributes that are supported by a control, consult the tag library descriptor (*.tld file) for that control. Table 2. Event attributes

Attribute

Description

onchange

Event fired when the use changes the control. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true). The onchange event is not handled immediately. It is handled on the server only when the form is submitted (for example, by an onclick event). Some controls do not implement an onchange event.

onselect

Event fired when the user selects the control, such as an option in a list. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). Some controls do not implement an onselect event.

runatclient

Specifies that the event should run on the client (True) or the server (False). The onchange event cannot run on the client. Some controls do not implement a runatclient attribute.

onclick

Event fired when the user clicks the control, such a button. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). Some controls do not implement an onclick event.

Action attributes The following attributes are common to most Documentum-enabled action controls. For the full list of attributes that are valid for a control, see the tag library descriptor that contains the control definition.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

15

Controls Reference

Table 3. Common action control attributes

Attribute

Description

action

ID of the action to be launched by the control. This value matches the action id attribute in the action definition.

showifinvalid

Indicates whether, when the configuration service cannot resolve the action definition: • (True) the control is displayed as disabled (grayed out). • (False) the control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false. To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

showifdisabled

Whether, when one or more of the action preconditions returns false: • (True) the control is displayed as disabled (grayed out). • (False) the control is not displayed.

disabledstyle

Entire CSS-syntax style sheet rule (enclosed in quotes) to apply to the disabled control.

disabledclass

CSS class to apply to the disabled control.

oncomplete

Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

Dynamic action attribute values The dynamic attribute is used to specify when the action should be launched based on the conditions of other controls on the page. The JSP page must include the JavaScript file /wdk/include/dynamicAction.js. The dynamic attribute can have one of the following values:

16

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionbutton

Attribute

Description

singleselect

The action can apply to only one selection or object.

multiselect

The action can apply to more than one selection or object (only in classic view or objectlist).

generic

The action can be launched regardless of selections by the user. The selections are essentially ignored.

genericnoselect

The action cannot be launched if any items on the page are selected.

false

(Default) The action is not dynamic.

Note: Dynamic action controls do not support the oncomplete attribute.

Runtime tag attribute override Some attribute values can be overridden by another attribute. This allows the source of a value to come from the JSP page, a localized set of strings, a datafield, or a value based on user context. For example, the datafield attribute is commonly used to override a label or value attribute. The tag value that will be displayed is evaluated at run time. If more than one of the following attributes are available for a control, the hierarchy of overrides is as follows: •

value or label attribute sets the value

•

nlsid overrides the value

•

datafield overrides the value and nlsid

•

contextvalue overrides the datafield, nlsid, and value

Actions actionbutton Purpose Generates a button that has an associated action.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

17

actionbutton

Attributes action

(Required) ID of the action to be launched by this control.

align

(Optional) Deprecated in 6.0.6.0: This attribute is ignored.Pre-6.0: (Image label only) Alignment of the label text.

cssclass

(Optional) CSS class that is applied to this control.

datafield

(Optional) Overrides the label value with a value from a data source.

disabledclass

(Optional) Deprecated in 6.0. CSS class to apply to the disabled control.

disabledstyle

(Optional) Deprecated in 6.0. Entire CSS-syntax style sheet rule (enclosed in quotes) to apply to the disabled control..

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

height

(Optional) Height of the image.

hotkeyid

(Optional) Value of a id attribute in the hotkeys configuration file (hotkeys.xml, located in /webcomponent/config) that references the keyboard shortcut command string for this control.

id

(Optional) ID for this control. The ID is generated by the framework. You can also set the ID in the JSP page.

imagefolder

(Optional) Deprecated in 6.0.6.0: Sets the folder that the button graphics are stored in. If the graphics are not found in this folder or this attribute is not specified, then an HTML button is rendered.Pre-6.0: Sets the folder that the button graphics are stored in. If graphics are not found in this folder, an HTML button will be drawn.

label

(Optional) Button label text (string value or element).

18

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionbutton

name

(Optional) Name for this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label value (that is, it overrides the datafield and label attributes).

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

oncompleteclient

(Optional) For internal use only.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

19

actionbutton

character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute. Since 6.0. tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

width

(Optional) Width of the image.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage The button is not shown if the action cannot be resolved. The button is displayed as disabled if the action cannot be executed. Use the <argument> tag to set context. In pre-6.0, by default, this control rendered the HTML tag; if the imagefolder attribute was specified, then the ......

xxxLABELxxx

HTML tags were rendered; if the src attribute was specified then the HTML tag was rendered. In 6.0, by default this control renders the tag; using the imagefolder attribute and its associated attributes (disabledstyle, disabledclass, align) are deprecated. Also, specifying the src attribute renders the ... HTML tags.

20

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionbuttonlist

actionbuttonlist Purpose Generates a type-based list of action buttons. The actions that will be displayed are configured in the tag of action configuration files (dm_typename_action.xml).

Attributes cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the scope field. For example, it can be used to display only a certain type of object in the actionlist on a per row basis in a datagrid.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

listid

(Optional) ID of the actionlist to use.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

separatorhtml

(Optional) HTML string to be displayed between each action control (for formatting purposes).

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

21

actionimage

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

actionimage Purpose Generates an image that launches an action when selected.

Attributes action

(Required) ID of the action to be launched by this control.

alttext

(Optional) Text to display when holding the mouse pointer over this control.

border

(Optional) Border in pixels around the image. Default is 0 (zero) pixels (that is, no border).

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the label value with a value from a data source; overrides the URL defined in src attribute.

datafielddisabled

(Optional) Overrides srcdisabled value.

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

height

(Optional) (Image action buttons only) Height of the button.

22

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionimage

hotkeyid

(Optional) Value of a id attribute in the hotkeys configuration file (hotkeys.xml, located in /webcomponent/config) that references the keyboard shortcut command string for this control.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) String value or element (which maps to a string label) to be rendered in addition to the image.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the datafield and label values.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

oncompleteclient

(Optional) For internal use only.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

showimage

(Optional) Whether to display the icon (True) or not (False). Default is True.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

23

actionimage

showlabel

(Optional) Whether to display a label (True) or not (False). Default is False.

src

(Optional) URL to the image.

srcdisabled

(Optional) Image to be used when the action is disabled.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String to display when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) (Image action buttons only) Width of the button.

24

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionlink

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

actionlink Purpose Generates an HTML link that has an associated action. The link is not shown if the action cannot be resolved. The link is shown as disabled if the action cannot be executed. Use the <argument> tag to set context.

Attributes action

(Required) ID of the action to be launched by this control.

alttext

(Optional) Text to display when holding the mouse pointer over this control.

border

(Optional) Border in pixels around the image. Default is 0 (zero) pixels (that is, no border).

cssclass

(Optional) CSS class that is applied to this control.

datafield

(Optional) Overrides label or NLS value with string from a data source.

datafielddisabled

(Optional) Overrides srcdisabled value.

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

25

actionlink

height

(Optional) (Image action buttons only) Height of the button.

hotkeyid

(Optional) Value of a id attribute in the hotkeys configuration file (hotkeys.xml, located in /webcomponent/config) that references the keyboard shortcut command string for this control.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID for the control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Contains a string value or element that maps to a string label that is displayed in the user interface.

linkspacer

(Optional) Width (in pixels) to display as space between dynamic links. Space is collapsed when this control is not visible.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label value.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

oncompleteclient

(Optional) For internal use only.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

26

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionlink

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

showimage

(Optional) Whether an image is displayed with the link (True) or not (False). Default is False.

showlabel

(Optional) Whether the label is displayed (true) or not (false). Default is True.

src

(Optional) URL to the image.

srcdisabled

(Optional) Image to be displayed when the action is disabled.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") that is applied to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

27

actionlinklist

tooltipnlsid

(Optional) NLS lookup key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) (Image action buttons only) Sets the width of the button.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

actionlinklist Purpose Generates a list of action controls based on object type. The actions that are displayed are configured in the element of action configuration files (dm_typename_action.xml). You can use more than one actionlinklist control with the same scope in a JSP page, provided the listid attribute has a different value. This allows you to display different actions for the same object type on different screens.

Attributes columns

(Optional) Number of columns in which to display the list in a table.

cssclass

(Optional) CSS class to apply to this control.

28

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionlinklist

datafield

(Optional) Overrides the scope field. For example, it can be used to display only a certain type of object in the actionlist on a per row basis in a datagrid.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

listid

(Optional) ID of the actionlist to use. The ID of the list to use within the scope. If it is not specified, then the value of "default is used.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

separatorhtml

(Optional) HTML string to be displayed between each action control (for formatting purposes).

showimages

(Optional) False to override images set in a component XML definition.

showlabels

(Optional) False to override labels set in component XML definition.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") applied to this control.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

29

actionmenuitem

actionmenuitem Purpose Generates a menu item that launches an action.

Attributes action

(Required) ID of the action to be launched by this control.

cssclass

(Optional) CSS class that is applied to this control.

datafield

(Optional) Overrides menu item string or nlsid from a data source.

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

hotkeyid

(Optional) Value of a id attribute in the hotkeys configuration file (hotkeys.xml, located in /webcomponent/config) that references the keyboard shortcut command string for this control.

id

(Optional) ID of the control. The ID is generated by the framework. You can also set the ID in the JSP page.

imageicon

(Optional) URL to an image to be displayed as a menu item.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the value attribute value.

30

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionmenuitem

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

oncompleteclient

(Optional) For internal use only.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") that is applied to this control.

value

(Optional) Menu item string.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Menu items do not pass arguments. Arguments are passed to the menu action through an actionmultiselect control. This tag is also used to pass arguments to an action that does not have a selected object, such as import. An action may use only some of the arguments in the actionmultiselect tag, because it contains arguments for all possible multiselect actions on the page. Arguments can

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

31

actionmultiselect

also be passed within an actionmultiselectcheckbox tag, but those arguments will not be passed to genericnoselect actions, that is, actions that ignore selected objects. Note: You can pass arguments through the actionmultiselectcheckbox control even when row selection is enabled and checkboxes are not used.

actionmultiselect Purpose Supports multiple selection with an associated action. Contains action controls with the dynamic attribute, such as actionmultiselectcheckbox or actionlink. The action on multiply selected items is specified by either the contained action control or by an actionmenuitem control. The actionmultiselect control passes nested arguments (in <argument> tags) to the control that performs the action. Multiple selection is supported only in classic or objectlist view.

Attributes id

(Optional) ID of the control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

selectionargs

(Optional) Comma-separated list of arguments used to uniquely identify selected items.

selectiongroupargs

(Optional) Comma-separated list of arguments used to uniquely identify an item’s group. Actions are disabled when the selected item’s selectiongroup attribute(s) do not share the same value.

Description Since 5.x

32

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionmultiselectcheckall

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Use the optional selectionargs attribute to identify each selected item in the datagrid. This will ensure that the same items are selected when a component returns. The following example from searchresultslist.jsp adds arguments for a selection group, which ensures that the action cannot be performed unless the multiple objects that are selected share the same repository: ...

actionmultiselectcheckall Purpose Generates a checkbox that checks all objects in a list. When checked, an action can be performed on all objects. In accessibility mode, this control generates a link to a global actions page, which displays actions that do not require a selected object.

Attributes cssclass

(Optional) CSS class to apply to this control.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

33

actionmultiselectcheckbox

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

actionmultiselectcheckbox Purpose Generates a checkbox that has one or more associated actions. Must be contained within an tag in a datagrid header. All action controls on the page with the dynamic value set to multiselect are associated with the checkbox. In accessibility mode, this control generates a link to an actions page for the object.

34

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

actionmultiselectcheckbox

Attributes cssclass

(Optional) CSS class to apply to this control.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

value

(Optional) (Boolean) Checkbox is checked (True); checkbox is unchecked (False). Default is false.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

35

docbaseattribute

Attributes docbaseattribute Purpose Displays the label and value of an object specified in the associated <docbaseobject> tag. This control generates the following controls: docbaseattributevalue (which validates against the data dictionary), docbaseattributelabel, and some HTML table tags. This control is used within a table or within a component class.

Attributes attribute

(Optional) Name of an object attribute.

col1

(Optional) HTML to be rendered between label and value. Default is . For example: col1=":"

col2

(Optional) HTML to be rendered between col1 and the value. Default is an empty cell:

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides attribute value.

docbaseattributevalueassistance

(Optional) Name of the docbaseattributevalueassistance control in which a list of value is specified.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether this control accepts focus (True) or not (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lines

(Optional) Number of lines to display for an attribute. Use the lines and the size attributes to display the attribute.

36

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattribute

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control on the JSP. For example, sets the object and sets the attribute for that object.

post

(Optional) HTML to render after this control. Default = (closes the row).

pre

(Optional) HTML to render before this control. Default = (opens the row).

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

required

(Optional) Whether the attribute is required (True) or not (False).

showobjectidasname

(Optional) Whether to to display the name of the object (False) or override it with the object ID (True) . Default is true. You can use a formatter in a docbaseobject configuration file to override this value.

size

(Optional) Size of this control.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

validate

(Optional) Whether to enable data dictionary validation (True) or disable it (False). Default is true.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

37

docbaseattributedelegate

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage To format the attributes that are displayed by this control, wrap the control in a formatter control. For example, you can format a boolean value with booleanformatter, a date with datevalueformatter. Other formatters include htmlsafetextformatter, numberformatter, stringlengthformatter, multilinestringlengthformatter, docformatvalueformatter, docsizevalueformatter, folderexclusionformatter, rankvalueformatter, and vdmbindingruleformatter. If you wish to generate a list of attributes from the data dictionary rather than using individual attribute controls, use a docbaseattributelist control. If you need to do custom (not data dictionary) validation for the attribute, do not use this control. Use the repositoryattributevalue tag with docbaseattributelabel. The docbaseattributevalue tag performs data dictionary validation and accepts other validators. If you need value assistance for the attribute, provide a name for your value assistance set as follows:

The values for the value assistance list are provided by docbaseattributevalueassistance value tags, either in the JSP page or in the component class. See docbaseattributevalueassistancevalue, page 51 for details.

docbaseattributedelegate Purpose Displays, in a datagrid, pseudoattributes and attributes for which there is a docbaseobjectconfiguration file. If there is no custom configuration, this control works the same as the docbaseattribute control.

38

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributedelegate

Attributes attribute

(Optional) Name of the object attribute to display.

col1

(Optional) HTML to be rendered between the label and value. Default = . For example: col1=":"

col2

(Optional) HTML to be rendered between the HTML generated by the col1 attribute and the value. Default = an empty cell:

cssclass

(Optional) the CSS class to apply to this control.

datafield

(Optional) Name of the datafield to override the attribute value.

docbaseattributevalueassistance

(Optional) Name of the docbaseattributevalueassistance control in which a list of value is specified.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether this control accepts focus (True) or not (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lines

(Optional) Specifies the number of lines to display for an attribute. Use the lines and the size attributes to display the attribute.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control on the JSP. For example, sets the object and sets the attribute for that object.

post

(Optional) HTML to render after this control. Default = (that is, closes the row).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

39

docbaseattributedelegate

pre

(Optional) HTML to render before this control. Default = (that is, opens the row).

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

required

(Optional) Whether the attribute is required (True) or optional (False)

showobjectidasname

(Optional) Whether to to display the name of the object (False) or override it with the object ID (True) . Default is true. You can use a formatter in a docbaseobject configuration file to override this value.

size

(Optional) Size of this control.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

validate

(Optional) (Boolean) Indicates whether to validate the control (True) or not (False). Default is true.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage To format the attributes that are displayed by this control, wrap the control in a formatter control. For example, you can format a boolean value with booleanformatter, a date with datevalueformatter. Other formatters include htmlsafetextformatter, numberformatter, stringlengthformatter,

40

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributelabel

multilinestringlengthformatter, docformatvalueformatter, docsizevalueformatter, folderexclusionformatter, rankvalueformatter, and vdmbindingruleformatter. If you need to do custom (not data dictionary) validation for the attribute, do not use this control. Use the repositoryattributevalue tag with docbaseattributelabel. The docbaseattributevalue tag performs data dictionary validation and accepts other validators. If you need value assistance for the attribute, provide a name for your value assistance set as follows:

The values for the value assistance list are provided by docbaseattributevalueassistance value tags, either in the JSP page or in the component class. See docbaseattributevalueassistancevalue, page 51for details.

docbaseattributelabel Purpose Displays the label for an attribute of an object specified in the associated <docbaseobject> tag.

Attributes attribute

(Optional) Name of the object attribute for which to display a label.

datafield

(Optional) Overrides the attribute value.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

41

docbaseattributelist

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

docbaseattributelist Purpose Displays all visible attributes of the Documentum object specified as the associated docbaseobject control. Attributes are rendered by category as defined in the data dictionary or configuration file. Each attribute is generated as a docbaseattribute control instance that encapsulates data dictionary information.

Attributes attrconfigid

(Required) Configuration ID to identify which control definition file to use. Must correspond to the value for id in in the corresponding control definition file.

categorypost

(Optional) HTML string to render after each category. Scripts are not supported. Default is (taht is, closes the row).

categorypre

(Optional) HTML string to render before each category. Scripts are not supported. Default is

---

col1

(Optional) HTML string to render between the label and value. Scripts are not supported. Default is :

col2

(Optional) HTML string to render between the value and validator. Scripts are not supported. Default is

42

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributelist

cssclass

(Optional) CSS class to apply to this control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

morelinkpost

(Optional) HTML string to render after the Show More link. Scripts are not supported. Default is

morelinkpre

(Optional) HTML string to render before the Show More link. Scripts are not supported. Default is

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed. 6.0: Changed from Required to Optional.

object

(Required) Name of associated docbaseobject control on the JSP page.

post

(Optional) HTML string to render after each docbaseattribute control. Scripts are not supported. Default is (closes the row)

pre

(Optional) HTML string to render before each docbasattribute control. Scripts are not supported. Default is

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

separator

(Optional) HTML to render as a separator between attributes. Default =

---

. Valid for 5.2 repositories only.

showcategorynames

(Optional) Whether to display category names in the user interface (True) or not (False). If there is only one category or the component definition’s <showpagesastabs> element content is true, the category name is not displayed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

43

docbaseattributelist

showobjectidasname

(Optional) Whether to to display the name of the object (False) or override it with the object ID (True) . Default is true. You can use a formatter in a docbaseobject configuration file to override this value.

size

(Optional) Size (in pixels) of this control.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visiblecategory

(Optional) Comma-separated string that specifies the categories to display. Default is null (that is, all categories are displayed).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage A single docbaseattributelist control in the JSP eliminates the need for a separate docbaseattribute control for each attribute to be listed. Attributes are displayed in categories, and categories are

44

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributeproxy

displayed in the user interface as tabs. You can configure the attributes that are displayed in categories using the data dictionary or an attributelist Configuration file. You can display a different set of attributes for each component that displays attributes and for any context that is defined by a qualifier in your application, for example, checkin, checkin by administrator, checkin of a custom type. To set a different docbaseattributelist configuration in your behavior class depending on business rules, for example, to display a particular attribute only when a business condition is met, put two or more docbaseattributelist controls within a panel control on the page. Show or hide each panel using the panel setVisible method to use the proper attribute list, for example: Panel attrlst1 = (Panel) getControl(ATTRLST1PANEL, Panel.class); attrlst1.setVisible(true); Panel attrlst2 = (Panel) getControl(ATTRLST2PANEL, Panel.class); attrlst1.setVisible(false);

Docbaseattributelist controls are configured in a configuration file. For more information on configuring attributelist controls, see "docbaseattributelist in Web Development Kit Development Guide.

docbaseattributeproxy Purpose Used to represent any control that is associated with a docbaseobject.

Attributes attribute

(Required) Attribute to represent.

controltorepresent

(Required) Name of the input control to represent.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

45

docbaseattributeseparator

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of the docbaseobject tag on the JSP page. In the following example, the object being validated is named "obj, so the value of the object parameter for this validator would be "obj:

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage This control is used only to validate attributes that are listed as ignored attributes in a docbaseattributelist configuration. For example, the list of available formats is displayed by the datadropdownlist control named "formatList" in the Webtop import JSP page, and the user’s selection should be validated against object constraints for the selected object type. The format attribute is listed in the element of import_docbaseattributelist.xml. In order for the selection to be validated, use the validator to validate the control on the JSP page, similar to the following:

docbaseattributeseparator Purpose Generates a separator. This control is rendered by the docbaseattributelist control.

46

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributevalue

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

separator

(Optional) HTML to render as a separator between attributes. Default =

---

.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

docbaseattributevalue Purpose Displays the value of an object that is specified in the associated <docbaseobject> tag.

Attributes attribute

(Optional) Name of the object attribute for which to display its value.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides attribute value.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

47

docbaseattributevalue

docbaseattributevalueassistance

(Optional) Name of the docbaseattributevalueassistance control in which a list of value is specified.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lines

(Optional) Number of lines to display for an attribute value. Use the lines and the size attributes to display the value returned for an attribute.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of the associated docbaseobject control.

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

required

(Optional) Whether a value is required in the user interface (True) or not (False). Does not override data dictionary enforcement.

showobjectidasname

(Optional) Whether to to display the name of the object (False) or override it with the object ID (True) . Default is true. You can use a formatter in a docbaseobject configuration file to override this value.

size

(Optional) Size of this control.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

48

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributevalue

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

validate

(Optional) Whether to enable data dictionary validation (True) or disable it (False). Default is true.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Use this tag and a docbaseattributelabel tag, if you need to use a custom validator for your attribute value. This tag generates a docbaseattributevalidator control, so it will be automatically validated against data dictionary constraints that have been set up for the attribute. For information on using the docbaseattributevalueassistance attribute to set up non-data dictionary value assistance, see docbaseattribute, page 36.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

49

docbaseattributevalueassistance

docbaseattributevalueassistance Purpose Displays an open-ended or closed set of values for value assistance. The attribute must not have value assistance set up in the DocApp.

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

islistcomplete

(Optional) Whether the user can add values to the set of values (False) or not (True).

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Specify the name of your list as the value of the docbaseattributevalueassistance attribute on the docbaseattribute control. In the following example, the value assistance list is named my_resultset:

Add the docbaseattributevalueassistance control. The values are specified by docbaseattributevalueassistancevalue tags or by the component class. See docbaseattributevalueassistancevalue, page 51for an example of providing values in the component class. Values in the JSP page are shown in the following example. If the values are to be provided by the component class, the docbaseattributevalueassistance control must be empty.

50

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseattributevalueassistancevalue



docbaseattributevalueassistancevalue Purpose Displays a value for a non-data dictionary list of values for an attribute. The attribute must not have data dictionary value assistance set up.

Attributes datafield

(Optional) Name of the datafield that provides the value for the attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Label for the value.

labeldatafield

(Optional) Name of the datafield that provides a label for the value. Overrides the label and nlsid attributes.

locale

(Optional) Locale for which the value is valid. If no locale attribute is specified, the value is displayed for all locales.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

value

(Optional) Valid value for the attribute.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

51

docbaseattributevalueassistancevalue

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Specify the name of your value assistance list as the value of the docbaseattributevalueassistance attribute on the docbaseattribute control. In the following example, the value assistance list is named my_resultset:

Add the docbaseattributevalueassistance control. The values are specified by docbaseattributevalueassistancevalue tags or by the component class. Values in the JSP page are shown in the following example.

If the values are to be provided by the component class, the docbaseattributevalueassistance control must be empty, for example:

The values are set in the component class similar to the following example: DocbaseAttributeValueAssistance attributeVA = (DocbaseAttributeValueAssistance) getControl( "my_resultset", DocbaseAttributeValueAssistance.class); attributeVA.setMutable(true); DocbaseAttributeValueAssistanceValue attributeVAValue = new DocbaseAttributeValueAssistanceValue(); attributeVAValue.setLabel("Value A"); attributeVAValue.setValue("valA"); attributeVA.addValue(attributeVAValue); DocbaseAttributeValueAssistanceValue attributeVAValue2 = new DocbaseAttributeValueAssistanceValue();

52

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbasemultiobjects

attributeVAValue2.setLabel("Value B"); attributeVAValue2.setValue("valB"); attributeVA.addValue(attributeVAValue2);

docbasemultiobjects Purpose Retrieves information about multiple, selected objects and refreshes the dependent value assistance cache.

Attributes configid

(Required) ID of a repositoryobject configuration file whose root element is <docbaseobjectconfiguration>. Default is attributes.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objectids

(Optional) IDs of the selected objects.

validate

(Optional) (Boolean) Whether to validate the control (True) or not (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

53

docbaseobject

docbaseobject Purpose Hidden control that specifies a Documentum object. Reference this control in docbaseattribute, docbaseattributevalue, and docbaseattributelist controls to display attributes of the object. Validation and data dictionary values are read for the object type. If you specify the type attribute.

Attributes configid

(Optional) ID of a repositoryobject configuration file whose root element is <docbaseobjectconfiguration>.

datafield

(Optional) Overrides the objectid attribute value.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

istype

(Optional) Indicates that the object should be used as a type object, valid only if src or datafield is specified. If src returns a list of object IDs, you must set istype to false.

lifecycleid

(Optional) ID of a lifecycle, if a lifecycle type is specified or istype equals true.

lifecyclestate

(Optional) Name of a lifecycle if a lifecycle type is specified or istype equals true.

modifyonversion

(Optional) True, if the object will be checked in. This will allow a user to modify attributes during checkout.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objectid

(Optional) Documentum object ID.

src

(Optional) DQL query to get the object.

type

(Optional) Name of an object type. Specify this attribute only if the object is used as a type object.

validate

(Optional) (Boolean) Indicates whether to validate the control (True) or not (False).

54

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseobject

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage You can modify how certain attributes or attribute types are displayed by using a formatter class. You can modify how the attribute is saved by using a value handler class. These classes are used to display or handle data in a docbaseattribute, docbaseattributevalue, or docbaseattributelist control. You can modify which control is used to render an attribute by specifying a tag class that extends DocbaseAttributeValueTag. You can add configuration elements that are used by the formatter, handler, or tag class. Note: Docbaseobject configuration files are read only for docbaseobject controls on a JSP page. Custom rendering is not performed in a listing view such as the doclist component in which multiple objects are displayed. Custom formatters, handlers, and custom tag classes for objects must be registered in a docbaseobject configuration file whose root element is <docbaseobjectconfiguration>. A JSP page references this configuration by setting the configid attribute of to the same value as the id of the <docbaseobjectconfiguration> element. If this attribute is not specified on the docbaseobject tag, the default configuration is used. This default configuration has an id of "attributes and is found in /webcomponent/config/library/docbaseobjectconfiguration_dm_sysobject.xml. The DocbaseObject methods setType() and setObjectId() cannot be used together. An IllegalArgumentException will be thrown. To get all of the docbaseattributevalue controls that use a particular docbaseobject in the page, use code in similar to the following your component class: DocbaseObject docbaseObj = (DocbaseObject) getControl("obj", DocbaseObject.class); FindValidAttributeValue v = new FindValidAttributeValue( docbaseObj.getName()); this.visitDepthFirst(v); Iterator it = v.getAttributeValues(); while (it.hasNext() == true) { DocbaseAttributeValue value = (DocbaseAttributeValue) it. next(); System.out.println(value.getAttribute() + ":" + value. getValue()); }

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

55

multiobjectsdocbaseattribute

multiobjectsdocbaseattribute Purpose Displays the label and value of an attribute by creating the MultiObjectsDocbaseAttributeLabel and MultiObjectsDocbaseAttributeValue controls.

Attributes attribute

(Optional) Name of the attribute to display.

col1

(Optional) HTML string to render between the label and value. Scripts are not supported. Default = :

col2

(Optional) HTML string to render between the value and validator. Scripts are not supported. Default =

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lines

(Optional) Number of lines to display for an attribute. Use the lines and the size attributes to display this attribute.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objects

(Required) Name of the DocbaseMultiObjects control to associate with this control.

post

(Optional) HTML string to render after each docbaseattribute control. Scripts are not supported. Default = (closes the row).

pre

(Optional) HTML string to render before each docbasattribute control. Scripts are not supported. Default = .

56

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

multiobjectsdocbaseattributelabel

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

required

(Optional) Whether the attribute is required.

style

(Optional) CSS rule enclosed in quotation marks; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

validate

(Optional) (Boolean) Whether to validate the control (True) or not (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

multiobjectsdocbaseattributelabel Purpose Displays the label of a common attribute for multiple, selected objects.

Attributes attribute

(Optional) Name of the attribute of the label to display.

cssclass

(Optional) CSS class to apply to this control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

57

multiobjectsdocbaseattributelist

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objects

(Required) Name of the DocbaseMultiObjects control to associate with this control..

style

(Optional) CSS rule enclosed in quotation marks; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

multiobjectsdocbaseattributelist Purpose Displays all visible attributes of the selected objects associated with the DocbaseMultiObjects control.

Attributes attrconfigid

(Required) Configuration ID to identify the control definition file to use. Must correspond to the value for id in in the corresponding control definition file.

col1

(Optional) HTML string to render between the label and value. Scripts are not supported. Default = :

58

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

multiobjectsdocbaseattributelist

col2

(Optional) HTML string to render between the value and validator. Scripts are not supported. Default =

cssclass

(Optional) CSS class to apply to this control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objects

(Required) Name of the DocbaseMultiObjects control to associate with this control.

post

(Optional) HTML string to render after each docbaseattribute control. Scripts are not supported. Default = (closes the row).

pre

(Optional) HTML string to render before each docbasattribute control. Scripts are not supported. Default = .

separator

(Optional) HTML to render as a separator between attributes. Default =

---

. Valid for 5.2 repositories only.

showcategorynames

(Optional) Whether to display category names in the user interface (True) or not (False). If there is only one category or the component definition’s <showpagesastabs> element content is true, the category name is not displayed.

style

(Optional) CSS rule enclosed in quotation marks; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"Since 6.0.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

59

multiobjectsdocbaseattributevalue

multiobjectsdocbaseattributevalue Purpose Displays the value of a common attribute for multiple, selected objects.

Attributes attribute

(Optional) Name of the attribute of the value to display.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

hidden

(Optional) (Boolean) Whether this control is hidden (True) or not (False). Default is False.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lines

(Optional) Number of lines to display for an attribute. Use the lines and the size attributes to display this attribute.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objects

(Required) Name of the DocbaseMultiObjects control to associate with this control.

readonly

(Optional) Whether this control is read-only (True) or read-write (False). This attribute does not override or change the status of the object attribute value in the repository; it only applies to the rendering of the object attribute in the user interface. You use the attributes component’s readOnly parameter to override this attribute’s value of false.

required

(Optional) Whether the attribute is required (True) or optional (False).

60

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

browserrequirements

style

(Optional) CSS rule enclosed in quotation marks; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

validate

(Optional) (Boolean) Whether to validate the control (True) or not (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Client browser detection browserrequirements Purpose Looks up the supported IE and Netscape versions as defined in the element of app.xml. If the browser is not supported, is on an unsupported platform, or has no JVM, an error message is displayed.

Attributes None.

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

61

checkjvmapplet

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

checkjvmapplet Purpose Generates an applet that checks the client browser JVM and offers the option of installing the Sun VM if it is not installed. This control is used by applications or components that must use the Sun VM. The applet is used by the Web Workflow Manager component.

Attributes align

(Optional) Horizontal alignment of applet text. Possible values are the same as those for the HTML IMG tag: left, right, top, texttop, middle, absmiddle, baseline, bottom, absbottom.

alt

(Optional) Text to be displayed when the browser understands the applet tag, but cannot run Java applets.

height

(Required) Applet height in the browser. 0 to hide the applet.

hspace

(Optional) Horizontal space between applet and surrounding text.

id

(Optional) ID for this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

successhandler

(Optional) Server-side event handler that handles the applet return.

vspace

(Optional) Vertical space between applet and surrounding text.

width

(Required) Applet width in the browser.

62

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

macclientdetect

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

macclientdetect Purpose Places a Macintosh client detector applet on the page. The applet detects the browser version number and stores the OS name in the session.

Attributes None.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The tag class has a public static method, MacClientDetector.getMacOsName(), that makes the Mac OS version available. This method returns one of three values: MacClientDetector.MAC_OSX, MacClientDetector.MAC_OS9, or null (the client is not Mac).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

63

attachmenticon

Collaboration attachmenticon Purpose Displays an icon that indicates whether an attachment exists for this event or not.

Attributes alttext

(Optional) Alternate text to be displayed as a tooltip and when the icon image fails to load.

datafield

(Optional) Overrides the value of src attribute with a URL from a data source.

height

(Optional) Height of this control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Overrides the alttext and nlsid attribute values.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the alttext attribute value.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). When onclick is used, the image is turned into a link.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

64

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

bannerbox

src

(Optional) URL to the icon image on the server. Can be a path on the server or in the repository, for example: src="/webtop/component/getcontent? objectId=0900303980005172" The repository icon may affect performance.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Width of this control.

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage This control is used within the datagrid control and is displayed as a preference column that can be turned on or off.

bannerbox Purpose Generates a box containing the Documentum Collaborative Services room banner. (Contains a roombanner tag on the JSP page.)

Attributes name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

65

commentimage

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

commentimage Purpose Render a comment Edit, Replyor Delete button.

Attributes alttext

(Optional) Text to display when holding the mouse pointer over this control.

border

(Optional) Border (in pixels) around the image. Default is 0 (zero) pixels (that is, no border).

datafield

(Optional) Overrides label or nlsid with data from a data source.

height

(Optional) (Image buttons only) Height of the button.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Value stored in the control and displayed as text on the button.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

66

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

commentimage

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label value.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Specifies that the event is to run on the client (True) or the server (False).

src

(Optional) Image to be used for the button.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

type

(Required) Edit mode: edit, reply, or delete.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) (Image buttons only) Specifies the width of the button.

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

67

commentrow

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage The control takes two arguments that are passed in using argument controls. The control must be contained within the commentrow control. Use the argument list to pass values to the onclick event. . . . ...

commentrow Purpose Renders the individual comments for a topic. Must be contained within a topic control.

Attributes cssclass

(Optional) CSS class to be used for previously read comments.

indentamount

(Optional) Indent amount (in pixels) for child comments. Default is 32.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

unreadstyle

(Optional) CSS style to be used for unread comments. Default is defaultUnreadCommentStyle.

68

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datatableeld

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

datatableeld Purpose Renders fields in a data table.

Attributes datafield

(Optional) Overrides the visible attribute value.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

mode

(Optional) Whether the datafield attribute value is a string or boolean. Default is string. If this attribute value is string and the datafield value’s string length is greater than 0, then the datafield attribute value is true. If this attribute value is boolean and the datafield attribute value is 1, T, or true, then the datafield attribute value is true.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

69

datatableeldPanel

reversevisible

(Optional) Whether the visible attribute is the boolean complement of the datafield attribute value (True) or not (False). Default is false. For example, when this attribute is set to true and the datafield value (in boolean mode) is true, then the visible attribute value is false.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

datatableeldPanel Purpose Determines the set of controls to be rendered for each datatablefield, page 69 control.

Attributes fields

(Optional) List of fields that correspond to object attribute names. This list is overridden by a list of columns in the component definition.

hascustomattr

(Optional) Whether the fields contain custom attributes and the fields are used within a datasortlink tag (True) or not (False). Setting this attribute to true ensures that the link is displayed correctly for sorting.

70

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

governedicon

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

labels

(Optional) Comma-separated string of fields to be displayed as labels. The values are overridden by labels set on columns in the component definition.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsids

(Optional) Comma-separated string of NLS IDs to display. The values are overridden by labels set on columns in the component definition.

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

governedicon Purpose Generates an icon indicating governance. Requires Documentum Collaborative Services enabled for the repository.

Attributes action

(Required) ID of the action to be launched by this control.

alttext

(Optional) Text to display when holding the mouse pointer over this control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

71

governedicon

border

(Optional) Border (in pixels) around the image. Default is 0 (zero) pixels (that is, no border).

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides label or NLS value with string from a data source.

datafielddisabled

(Optional) Overrides srcdisabled value.

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

height

(Optional) Height of the button.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID of this control.

label

(Optional) Link text.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label value.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

72

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

governedicon

showimage

(Optional) Whether to display the icon (True) or not (False).

showlabel

(Optional) Whether to display a label (True) or not (False).

src

(Optional) URL to the image.

srcdisabled

(Optional) Image to display when the action is disabled

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) (Image action buttons only) Width of the button.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

73

messageimportanceformatter

messageimportanceformatter Purpose Displays a string or icon for the message_importance attribute value of a dm_message_archive object.

Attributes hinlsid

(Optional) NLS lookup key. The string (or icon) corresponding to the NLS ID is substituted for a high importance value.

lownlsid

(Optional) NLS lookup key. The string (or icon) corresponding to the NLS ID is substituted for a low importance value.

normalnlsid

(Optional) NLS lookup key. The string (or icon) corresponding to the NLS ID is substituted for a normal importance value.

Description Since 6.0

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

msgattachmenticon Purpose Icon that indicates whether a dm_message_archive object has attachments or not.

74

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

recurrexceptionicon

Attributes None.

Description Since 6.0

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

recurrexceptionicon Purpose Displays an icon that indicates the kind of event (standalone exceptions or recurring events with exceptions).

Attributes alttext

(Optional) Alternate text to be displayed as a tooltip and when the icon image fails to load.

datafield

(Optional) Overrides the value of src attribute with a URL from a data source.

height

(Optional) Height of this control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Overrides the alttext and nlsid attribute values.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

75

recurrexceptionicon

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the alttext attribute value.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). When onclick is used, the image is turned into a link.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

src

(Optional) URL to the icon image on the server. Can be a path on the server or in the repository, for example: src="/webtop/component/getcontent? objectId=0900303980005172" The repository icon may affect performance.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Width of this control.

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage This control is used within the datagrid control and is displayed as a preference column that can be turned on or off.

76

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

richtextdisplay

richtextdisplay Purpose Displays rich text attributes as read-only. Requires Documentum Collaborative Services on the Content Server.

Attributes datafield

(Optional) Name of pseudo-attribute to be displayed; for example, content_value.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage You can configure the behavior of the rich text display control by extending the control configuration file /wdk/config/richtext.xml, which defines the following elements: Table 4. Rich text conguration elements



Remove the comments from this element to use the RichTextInputFilter class, which processes images and links that are entered by the user.



Remove the comments from this element to use the RichTextOutputFilter class, which processes image URLs for display in IE and Mozilla.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

77

richtextdocbaseattribute



Contains elements that govern HTML input.



Contains all HTML tags that are allowed within rich text input. Must include start and closing tag, for example, .



Contains all attributes that are allowed within HTML tags. Attributes are represented as though they were HTML tags, for example, .



Contains protocols that are permitted in links within rich text. For example, to prevent ftp URLs, remove from the list.



Contains stylesheet constructs that are not permitted, such as those that contain external links. For example:

sets the object and sets the attribute for that object.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

richtextdocbaseattributelabel Purpose Displays the label of a rich text pseudoattribute of an object specified in the associated docbaseobject tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this tag is only valid in the property sheet context. Requires Documentum Collaborative Services on the Content Server.

Attributes attribute

(Optional) Pseudo-attribute name.

datafield

(Optional) Name of the datafield that provides the label for the attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

79

richtextdocbaseattributevalue

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control.

object

(Required) Name of associated docbaseobject control.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

richtextdocbaseattributevalue Purpose Displays the value of a rich text pseudoattribute of an object specified in the associated docbaseobject tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this tag is only valid in the property sheet context. Requires Documentum Collaborative Services on the Content Server.

Attributes attribute

(Optional) Pseudo-attribute name.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

80

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

richtexteditor

object

(Required) Name of associated docbaseobject control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

richtexteditor Purpose Generates a rich text editing add-in. Requires Documentum Collaborative Services on the Content Server.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

81

richtexteditor

Attributes hasCharFormatting

(Optional) (Boolean) Whether the character formatting buttons are included in the toolbar (bold, italic, underline, text color, highlight color) (True) or not (False). Default is true.

hasClipboard

(Optional) (Boolean) Whether the clipboard button is included in the toolbar (True) or not (False). Default is true.

hasFonts

(Optional) (Boolean) Whether the font and font-size menus are included in the RTE toolbar (True) or not (False).

hasImages

(Optional) (Boolean) Whether the image button is included in the toolbar (True) or not (False). Default is true.

hasLinks

(Optional) (Boolean) Whether the link button is included in the toolbar (True) or not (False). Default is true.

hasParaFormatting

(Optional) (Boolean) Whether the paragraph formatting buttons are included in the toolbar (alignment, bullet list, numbered list, indent, outdent) (True) or not (False). Default is true.

hasSpellcheck

(Optional) (Boolean) Whether the spell check button is included in the toolbar (True) or not (False). (Windows only) Default is true.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

tooltipnlsid

(Optional)

value

(Optional) Text (in HTML format) that is being edited. Can be inherited from StringInputContol or re-implemented in the RTE control class if it does not extend StringInputControl.

82

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

richtexteditor

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage You can configure the behavior of the rich text editor by extending the control configuration file /wdk/config/richtext.xml, which defines the following elements: Table 5. Rich text conguration elements



Remove the comments from this element to use the RichTextInputFilter class, which processes images and links that are entered by the user



Remove the comments from this element to use the RichTextOutputFilter class, which processes image URLs for display in IE and Mozilla



Contains elements that govern HTML input



Contains all HTML tags that are allowed within rich text input. Must include start and closing tag, for example, .



Contains all attributes that are allowed within HTML tags. Attributes are represented as though they were HTML tags, for example, .



Contains protocols that are permitted in links within rich text. For example, to prevent ftp URLs, remove from the list.



Contains stylesheet constructs that are not permitted, such as those that contain external links. For example:

roombanner Purpose Generates a room banner. Requires Documentum Collaborative Services to be enabled for the repository.

Attributes height

(Optional) Height (in pixels) of the banner.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

objectid

(Optional) ID of a governed folder containing the room banner.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

85

showtopicdocbaseattribute

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

showtopicdocbaseattribute Purpose Displays the label and value of a rich text pseudoattribute of an object specified in the associated docbaseobject control. tag. Pseudo attributes are described in the object type’s docbaseattributelist xml file. The richtextdocbaseattribute control is only valid in the property sheet context. This control generates the following controls: richtextdocbaseattributevalue, richtextdocbaseattributelabel, and some HTML table tags. Requires Documentum Collaborative Services on the Content Server.

Attributes attribute

(Optional) Pseudo-attribute name.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control on the JSP. For example, sets the object and sets the attribute for that object.

86

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

showtopicdocbaseattributelabel

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

showtopicdocbaseattributelabel Purpose Displays the label of show topic pseudoattribute of an object specified in the associated docbaseobject tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this tag is only valid in the property sheet context.

Attributes attribute

(Optional) Pseudo-attribute name.

datafield

(Optional) Datafield that provides the label for the attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control.

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

87

showtopicdocbaseattributevalue

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

showtopicdocbaseattributevalue Purpose Displays the value of a show topic pseudoattribute of an object specified in the associated docbaseobject tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this tag is only valid in the property sheet context.

Attributes attribute

(Optional) Pseudo-attribute name.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

object

(Required) Name of associated docbaseobject control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

88

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

topic

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

topic Purpose Displays the threaded list of comments found for an object’s topic. The control should contain the comment control.

Attributes name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage The control data is set at runtime from a component by setting its dataprovider with a TopicResultSet of data that makes up the topic. For example: public void setTopicControl( ITopic topic, String[] attributes) { topicData = new TopicResultSet(attributes, topic);

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

89

topicpanel

Topic topicControl = (Topic)getControl( CONTROL_TOPIC, Topic.class); DataProvider dataProvider = topicControl.getDataProvider( ); dataProvider.setScrollableResultSet(topicData); }

topicpanel Purpose Hides a topic for repositories that do not have Documentum Collaborative Services enabled

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage To display a panel of topics, add the topicpanel and collaboration component similar to the following example:

90

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

topicstatus



topicstatus Purpose Generates an action icon that indicates the status of a discussion topic. A topic may be read, unread, or nonexistent. If an indicator icon is present, then clicking it will bring user to the page containing the topic. The control is used within the datagrid control and appears as a preference column that can be turned on or off.

Attributes action

(Required) ID of the action to be launched by this control.

alttext

(Optional) Text to display when holding the mouse pointer over this control.

border

(Optional) Border in pixels around the image. Default is 0 (zero) pixels (that is, no border).

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the label value with a value from a data source. Overrides the URL defined in src attribute

datafielddisabled

(Optional) Overrides srcdisabled value.

dynamic

(Optional) Specifies when the action is to be launched based on the conditions of other controls on the JSP. Only false can be specified for this attribute, if an event is specified for the oncomplete attribute. See .

height

(Optional) Height of the image.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

91

topicstatus

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) String value or element (which maps to a string label) to be rendered in addition to the image.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the datafield and label values.

oncomplete

(Optional) Event to be fired when an associated action has completed. This attribute cannot be used when the dynamic attribute is set to any value other than false.

showifdisabled

(Optional) Whether, when one or more of the action preconditions returns false: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed.

showifinvalid

(Optional) Indicates whether, when the configuration service cannot resolve the action definition: (True) this control is displayed as disabled (grayed out). (False) this control is not displayed. Default is false. A value of true overrides a visible attribute that is set to false.To hide all invalid actions in the application, set the value of to true in your custom app.xml file.

showimage

(Optional) Whether to display the icon (True) or not (False).

showlabel

(Optional) Whether to display a label (True) or not (False).

src

(Optional) URL to the image.

srcdisabled

(Optional) Image to be displayed when the action is disabled.

92

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

topicstatus

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) Width of the image .

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

93

hidden

Context hidden Purpose Generates a hidden control at the bottom of the page that stores serialized context information.

Attributes datafield

(Optional) Overrides value with data from a data source.

encrypt

(Optional) Whether data that is passed in the hidden control cannot (True) or can (False) be viewed by the browser "View Source" option. This property can be used on named controls only. Default is true.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event that is fired when this control is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted (for example, by an onclick event). The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

value

(Optional) Value stored in the control.

94

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

celllist

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Data display celllist Purpose Used within a table row () or tag to wrap a list of celltemplate tags. The cell templates will output columns of data dynamically.

Attributes fields

(Optional) List of fields that correspond to object attribute names. This list is overridden by a list of columns in the component definition.

hascustomattr

(Optional) Whether the celllist fields contain custom attributes and the celllist tag is used within a datasortlink tag (True) or not (False). Setting this attribute to true ensures that the link is displayed correctly for sorting.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

labels

(Optional) Comma-separated string of fields to be displayed as labels. The values are overridden by labels set on columns in the component definition.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

95

celltemplate

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsids

(Optional) Comma-separated string of NLS IDs to display. The values are overridden by labels set on columns in the component definition.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage If you specify columns in the component definition, they will override the fields that are specified To set the celllist fields programmatically, call the CellList method setFields() during onControlInitialized.

celltemplate Purpose Within a cell list tag, specifies a template output for a single column of data. The data that is rendered is supplied by the fields attribute. Template values are supplied by a field name, such as object_name, object type, such as double, or generic (matches everything).

96

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

celltemplate

Attributes field

(Optional) Name of a field corresponding to an object attribute name. If this attribute is specified, the type attribute cannot be used.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

type

(Optional) Object type. If this attribute is specified, the field attribute cannot be used. If neither field nor type attributes are set, then the cell is generic. The number type matches either an int or double datatype returned from DFC.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage Use within a tag. The fields for the template can be supplied as the value of the fields attribute on the JSP page or programmatically from the component configuration using the ComponentColumnDescriptorList object. WDK components that have a element in the component XML definition get the list of fields from the configuration. (They get the columns from ComponentColumnDescriptor.) Fields, labels, and nlsids that are configured in the component definition file override tag attributes in the JSP page. You can configure dynamic sets of data for display using and . If you are displaying the data in columns, you can use a combination of celllist and celltemplate controls within a table header row or within to provide column headers, sorting, and columns of data. See Web Development Kit Development Guidefor details.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

97

columnpanel

columnpanel Purpose Wraps a set of column controls in a table row to allow display or hiding of column data.

Attributes columnname

(Required) Name of this column. All column panels in a single row should use unique names.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

datacolumnbeginswith Purpose Enables displaying all column values that start with a user-entered string.

98

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datacolumnbeginswith

Attributes autocompleteenabled

(Optional) (Boolean) Enables (True) or disables (False) autocompletion on the control. Default is True.

autocompleteid

(Optional) Key used to store the autocomplete list in the user preferences. You can set the same ID on two text controls, for example, if they share the same set of suggestions. If the control does not have an ID specified, the ID is generated using this syntax: formid_controlid. formid is the form id attribute and controlid is the text control name. For docbaseattribute controls that render a text control, an ID is generated using the attribute name; for example, "keyword or "title.

casesensitive

(Optional)

column

(Optional) Column name to which to bind. If this control is within a celltemplate tag, you can use the datafield attribute instead.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) A value of CURRENT retrieves the value from the data source.

defaultonenter

(Optional) Whether pressing the Enter key calls the JavaScript handleKeyPress() function (True) or not (False). Must be used with a button (on the same page) that has its default attribute set to true. The button event is fired when the user presses the Enter key in the defaultonenter control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether this control accepts focus (True) or not (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

maxautocompletesuggestionsize

(Optional) Number of matching suggestions to display to the user. Default is 10.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

99

datacolumnbeginswith

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed. Required to bind to a filter item.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the initial search value (for example, Starts With).

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted.

onclick

(Optional)

prompt

(Optional)

runatclient

(Optional) Whether the onchange event is to run on the client (True) or the server (False).

size

(Optional) Size of this control.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional)

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional)

Description Since 6.0

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

100

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datagrid

Usage To format the value in this control, enclose it in a formatter control.

datagrid Purpose Displays results of a query or recordset as a table, generating opening and closing tags.

Attributes bordersize

(Optional) Size of the datagrid border.

cellpadding

(Optional) Space between cell contents and cell border.

cellspacing

(Optional) Spacing between the cells in the grid.

cssclass

(Optional) CSS class to apply to this control.

fixedheaders

(Optional) Boolean: Whether the datagrid header rows are to scroll with the body rows (False) or not (True). Default is false. To set this attribute value for all datagrid controls in your application, set the following element value in the app.xml file: <desktopui<..<fixedheaders>. This element’s default value is true.Since 6.0.

height

(Optional) Height of the datagrid.Since 6.0: When you specify a value for this attribute, scroll bars are generated for the contents of the datagrid that extend beyond the specified value. If you do not specify a value for this attribute on a datagrid control, the grid takes up the remaining height in the frame. Remaining elements on the page should be placed within the footer (anywhere between the end of datagridRow tag and the end of datagrid tag).

id

(Optional) ID if this control. The ID is generated by the framework. You can also set the ID in the JSP page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

101

datagrid

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

paged

(Optional) Whether paging is turned on (True) or off (False). All data is returned when paging is turned off. Default is false.

pagesize

(Optional) Number of result items on a page when paging is turned on.

preservesort

(Optional) Whether the datagrid preserves (True) the current sort settings between data refresh events or not (False). Default is false.

query

(Optional) DQL query passed to the data provider; for example:select group_name, r_modify_date from dm_group where group_name like ’a%’

recordcachecount

(Optional) Overrides the default number of records retrieved by the query and sets the number of records to be fetched.

rendertable

(Optional) Whether to suppress (False) or render (True) tags by the datagrid control. When the data rows are rendered within separate panes within a paneset control, set this value to false and insert tags manually within the pane control. Default is true.

rowselection

(Optional) Boolean: Enables (True) or disables (False) mouse or keyboard row selection (selecting one or more objects) and right-click context menus. Default is True. The app.xml file’s desktopui/datagrid/rowselection element must be set to true to enable this attribute.

sortcolumn

(Optional) Name of column on which to sort.

sortdir

(Optional) Sort direction: ascending (0) or descending (1). Default is 0.

sortmode

(Optional) Initial sort mode: text (0), case-insensitive text (1), or numeric (2). Default is 1.

102

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datagrid

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

width

(Optional) Width of the datagrid.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage This control can contain datagridrow, nodatarow, row, or HTML table row () tags. The data can be paged by adding a datapaging control and sorted by adding a datasortimage or datasortlink control into the grid control. To support row selection this control must be placed outside any HTML table tags. To generate scroll bars when the contents of the datagrid extend beyond datagrid’s height, specify a value in the height attribute. Examples Row selection

Since 6.0. To disable row selection for an individual datagrid row, set the rowselection attribute to false in the datagrid tag on the JSP page, for example:

Table 7, page 104 describes the interaction between the global row selection flag in app.xml and the datagrid attribute.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

103

datagridRow

Table 7. Row selection settings

app.xml

dmf:datagrid rowselection

Result

false

true or false

Checkboxes rendered, no mouse/keyboard row selection or context menus on any datagrid

true

true

No checkboxes rendered, row selection and context menus enabled for the datagrid

true

attribute not specified (for example, migrated customizations)

No checkboxes rendered, row selection and context menus enabled for the datagrid

true

false

Checkboxes rendered, no mouse/keyboard row selection or context menus on current datagrid

With row selection enabled in app.xml, contained checkboxes within a datagrid on the JSP page are rendered with a CSS rule of display:none. Rows can then be selected by mouse events or keyboard combinations. Link and action controls inside selectable rows are disabled. To migrate links and action controls within a datagrid row, move them to a context menu or a datagridrowevent tag.

datagridRow Purpose Generates rows of data inside a datagrid. Generates opening and closing tags within the tags generated by datagrid. Can contain element.

dataoptionlist Purpose Iterator that renders options as a HTML form option elements. Renders all of the data from the enclosing datadropdownlist or datalistbox.

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

112

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datapagesize

datapagesize Purpose Generates a page size control that allows the user to select the number of items in a page.

Attributes cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onselect

(Optional) Event fired when the user selects a page size value. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

pagesizevalues

(Optional) Comma-separated list of integer page-size values for the user to select.

preference

(Optional) Default value for the preferred data page size (which the user can override). The value can be read from a configuration file, such as /custom/app.xml, as the content of a dot-separated path of elements in the file. For example, preference=’application.display.streamline’ would be read from the following app.xml element path:... <streamline>10

runatclient

(Optional) Specifies that the onselect event is to run on the client (True) or the server (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

113

datapagesize

showdisplayinginfo

(Optional) Whether to show the total item count (True) or not (False)

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control. For example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage Cache size for the number of objects returned by a query is configurable in Databound.properties, in /WEB-INF/classes/com/documentum/web/form/control. Paging is configured on a JSP page that contains a datagrid. You can limit the choices for page sizes by setting the pagesizevalues of the

114

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datapaging

datapagesize JSP tag. You can set a default value for page size as the value of the preference attribute on the datapagesize tag.

datapaging Purpose Generates navigation links for a paged datagrid. Must be used within the datagrid control. Links will be rendered only when multiple pages of data are returned from the query.

Attributes cssclass

(Optional) CSS class to apply to this control.

gotopageclass

(Optional) CSS class to apply to the optional gotopage text box.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

showdisplayinginfo

(Optional) Whether to show the displaying X of Y items text (True) or not (False).

showfirstandlast

(Optional) Whether to show the first and last page links (True) or not (False).

showgotopage

(Optional) Whether to show the optional go-to-page text box (True) or not (False). Setting this attribute to true, enables the user to jump to any page in the dataset by entering a page value in the text box.

showimages

(Optional) Whether images (True) instead of text links (False) are displayed. The images must be placed in: /wdk/ theme_folder /images/paging. If the images are not found, text links are displayed. Default is true.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

115

datasortimage

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

datasortimage Purpose Generates a datasortimage control within the datagrid control. Provides an image that launches a sort of the dataset.

116

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datasortimage

Attributes column

(Optional) Column name to which to bind. If this control is within a celltemplate tag., you can use the datafield attribute instead.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the label and nlsid with data from the current celltemplate match. A value of CURRENT retrieves the value from the data source.

forwardicon

(Optional) URL to the forward sort icon.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

image

(Required) Image file name. The path to the image is resolved by the branding service.

mode

(Optional) Sort mode: text (0), case-insensitive text (1), or numeric (2).

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

reverseicon

(Optional) URL to the reverse sort icon.

reversesort

(Optional) Initial sort order of the displayed column: reverse (True), normal (False). Default is false.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

117

datasortlink

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

datasortlink Purpose Generates a datasortlink control within the datagrid control. Provides a column header sort link that allows the user to sort the results by column name.

118

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datasortlink

Attributes column

(Optional) Column name to which to bind. If this control is within a celltemplate tag, you can use the datafield attribute instead.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the label and nlsid with data from the current template match. A value of CURRENT retrieves the value from the data source.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

forwardicon

(Optional) URL to the forward sort icon.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Label for the data sort link.

mode

(Optional) Sort mode: text (0), case-insensitive text (1), or numeric (2).

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label value.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

reverseicon

(Optional) URL to the reverse sort icon.

reversesort

(Optional) Initial sort order of the displayed column: reverse (True), normal (False). Default is false.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

119

datasortlink

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control. For example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage If the datasortlink contains a celllist tag whose contents are resolved at runtime, make sure that the celllist tag properly reflects the type of datafield providing the link. For example, if the datafield maps to a custom attribute, set the hascustomattr attribute on the celllist tag to true.

120

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datatableeldpanel

datatableeldpanel Purpose Determines the set of controls to be rendered for each datatablefield, page 69 control.

Attributes fields

(Optional) List of fields that correspond to object attribute names. This list is overridden by a list of columns in the component definition.

hascustomattr

(Optional) Whether the fields contain custom attributes and the field is used within a datasortlink tag (True) or not (False). Setting this attribute to true ensures that the link is displayed correctly for sorting.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

labels

(Optional) Comma-separated string of fields to be displayed as labels. The values are overridden by labels set on columns in the component definition.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsids

(Optional) Comma-separated string of NLS IDs to display. The values are overridden by labels set on columns in the component definition.

Description Since 6.0

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

121

datatablerowattributelist

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

datatablerowattributelist Purpose Lists attributes in a datatable row.

Attributes attrconfigid

(Required) A configuration ID to identify which control definition file should be used. Must correspond to the value for id in <attributelist id="attributes"> in the corresponding control definition file.

categorypost

(Optional) pecifies an HTML string to render after each category. Scripts are not supported. Default = (closes the row)

categorypre

(Optional) Specifies an HTML string to render before each category. Scripts are not supported. Default =

morelinkpre

(Optional) Specifies an HTML string to render before the Show More link. Scripts are not supported. Default == (closes the row)

pre

(Optional) Specifies an HTML string to render before each docbasattribute control. Scripts are not supported. Default == . Valid for 5.2 repositories only.

showcategorynames

(Optional) Set to true to display category names in the UI. Category name is not shown if there is only one category or if <showpagesastabs> in the component definition equals true.

showobjectidasname

(Optional) Set to true to display the object ID as the name of the object. This value can be overridden by a formatter in a docbaseobjectConfiguration file. Default == true.

size

(Optional) Sets the size of the control in pixels.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

123

listbox

style

(Optional) A cascading style sheet rule enclosed in quotation marks; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}".

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visiblecategory

(Optional) Comma-separated string that specifies the categories that are visible. Default == null (all categories are visible)

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

listbox Purpose Holds option objects or a single dataoptionlist control holding a databound option.

124

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

listbox

Attributes cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether this control accepts focus (True) or not (False).

height

(Optional) Vertical length of the drop down list control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

multiselect

(Optional) Whether to enable (True) or disable (False) multiple selection in the listbox.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event that is fired when this control is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). The form is not submitted until the onselect event is fired.

runatclient

(Optional) Specifies that the onselect event is to run on the client (True) or the server (False).

size

(Optional) Number of rows of selectable data visible in the listbox (scrollbars are used if more rows are available).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control. For example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

125

listbox

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) The selected value.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

width

(Optional) Horizontal length of the drop down list control.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The multiselect attribute is only available if you retrieve the value in client-side JavaScript. Multiple selections are not passed to the component, because no server event is fired. For an example of a client-side implementation that retrieves multiple selections in the listbox, refer to searchsources_preferences.jsp and changesearchsources.jsp.

126

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

multiselector

multiselector Purpose Displays two lists. User can select items from a list and order the selected items. Items are moved between the unselected and selected list with Add and Remove buttons. Items are ordered on the selected items list with Up and Down buttons.

Attributes buttoncssclass

(Optional) CSS class to apply to button appearance.

buttoncssstyle

(Optional) CSS rule to apply to button appearance.

buttonheight

(Optional) Height (in pixels) of the button.

buttonimagefolder

(Optional) Location of the image folder, if buttons are used to display items.

buttonwidth

(Optional) Width (in pixels) of the button.

disabledclass

(Optional) CSS class to apply to the disabled control.

disabledstyle

(Optional) Entire CSS-syntax style sheet rule (enclosed in quotes) to apply to the disabled control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

items

(Optional) Serialized list of items to display in the available items listbox. The list must be a String array with value and label pairs (value must occur in the first position).

itemslabel

(Optional) Label for the available items list.

itemsnlsid

(Optional) NLS string for the available items list label.

listboxcssclass

(Optional) CSS class to apply to listboxes.

listboxcssstyle

(Optional) CSS rule to apply to listboxes.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

127

multiselector

listboxwidth

(Optional) Width (in pixels) of listboxes. Default is 200.

multiselect

(Optional) Whether to enable (True) or disable (False) selection of multiple items for Add or Remove. If a move operation is chosen, only the first selection is moved. Default is false.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

orderingenabled

(Optional) Whether to enable (True) or disable (False) Up and Down buttons, which change the order of the list. Default is true.

selecteditems

(Optional) Serialized list of items to appear in the selected items listbox.

selecteditemslabel

(Optional) Label for the selected items list.

selecteditemsnlsid

(Optional) NLS string for the selected items list label.

size

(Optional) Size of the listboxes. Default is 10.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The component can retrieve a list of selected items from the control by calling getSelectedItems() on the control. The buttons trigger client side events so that the client doesn’t have to make a round trip to the server every time a button is selected. When a trip to the server is made the control will update its data on the server side via a hidden field that keeps an updated item list. The List object that holds items has the following features: •

Each element in a List represents one item.

•

The element can be a String, which is a value with no label.

•

The element can be an array of one String

•

A serialized list of items can be an array of one string (value) or two strings (value and label).

128

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

nodataRow

If you supply the lists of available and selected columns in the JSP page, then the list must be serialized to a string before passing it in to the control. (You can create the serialized string from an ArrayList using the MultiSelectorUtil class static method encodeItemList(). If you supply a list in your component class, pass it in as ArrayList. In the following example from the VisibleRepositoryPreferences class, the class gets the controls on the JSP page, calls methods that get the ArrayList for each control, and initializes the items and selected items lists: public void onInit(ArgumentList args) { super.onInit(args); ... MultiSelector mltRepositories = (MultiSelector)getControl( REPOSITORY_SELECTOR, MultiSelector.class); mltRepositories.setSize("10"); //Get selected connection broker and port DataDropDownList docbrokerControl = (DataDropDownList) getControl( CONTROL_DOCBROKER,DataDropDownList.class); Label docbrokerPortNumberControl = (Label) getControl( CONTROL_DOCBROKER_PORT,Label.class); //Get all repositories for this connection broker ArrayList arrDocbases = getInvisibleRepositories( docbrokerControl.getValue(), docbrokerPortNumberControl. getLabel()); //Write the list to the available repositories list mltRepositories.setItems(arrDocbases); //Get previously selected repositories, set to selected items list mltRepositories.setSelectedItems(getVisibleRepositories()); }

nodataRow Purpose Supplies a row of static data that will be automatically displayed if the enclosing datagrid returns no data rows from the query. Must be contained within the datagrid control. You must provide . Use only in pages where your component needs to access controls in the row.

130

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

absolutelepathvalidator

Attributes align

(Optional) Horizontal alignment of the cells.

cssclass

(Optional) CSS class to apply to this control.

height

(Optional) Height of the row

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

style

(Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control.

valign

(Optional) Vertical alignment of the cells.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Data validation absolutelepathvalidator Purpose Validates a string file path using DFC utilities.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

131

absolutelepathvalidator

Attributes controltovalidate

(Required) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message displayed when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

132

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

comparevalidator

comparevalidator Purpose Validates an input control by comparing its value to a specified value or to another input control.

Attributes comparecontrol

(Optional) Name of the input control that contains the value with which to compare the current value. Overrides the comparevalue attribute.

comparevalue

(Optional) Value to compare with the current value.

controltovalidate

(Required) The control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

operator

(Optional) Comparison operator. Valid values are: equal, notequal, greaterthan, greaterthanequal, lessthan, lessthanequal.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

133

datetimevalidator

type

(Optional) Datatype of the value. Valid values are: string, integer.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

datetimevalidator Purpose Verifies that the date input for a control matches a valid pattern, such as "mm dd yyyy", or "mm dd yyyy hh:mi:ss". This validator does not need to be used on datetime controls, because the input control displays only valid choices for the user.

Attributes controltovalidate

(Required) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message displayed when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

134

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datevalidator

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

datevalidator Purpose Verifies that the dateinput control value is a valid date for the user’s locale. This validator does not need to be used on dateinput controls, because the input control displays only valid choices for the user. The name and controltovalidate attributes are required. This control cannot be used to validate any control other than dateinput.

Attributes controltovalidate

(Required) Name of the control to validate

cssclass

(Optional) CSS class to apply to this control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

135

docbaseattributevalidator

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

docbaseattributevalidator Purpose Renders several validators for attributes: inputmaskvalidator, multivaluesinputmaskvalidator, requiredfieldvalidator, and varequiredfieldvalidator. This validator (and its included validators) is generated by the docbaseattributevalue control, so that validation is performed automatically on attributes.

136

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbasemultiobjectsvalidator

Attributes controltovalidate

(Required) Name of the input control to validate.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage If you use a docbaseattributevalue control to render an attribute value, you do not need to use this validator.

docbasemultiobjectsvalidator Purpose Validates changes to all attributes that are common between multiple, selected objects.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

137

docbaseobjectattributevalidator

Attributes controltovalidate

(Required) Name of the input control to validate.

header

(Optional) Summary header message.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the header attribute value.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

docbaseobjectattributevalidator Purpose Validator used to validate any control that is associated with a docbaseobject. Deprecated as of version 6. See docbaseattributeproxy, page 45.

138

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

docbaseobjectattributevalidator

Attributes attribute

(Required) Attribute against which the control’s selected value is to be validated.

controltovalidate

(Required) Name of the input control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Message displayed when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

object

(Required) Name of the docbaseobject tag on the JSP page. In the following example, the object being validated is named "obj, so the value of the object parameter for this validator would be "obj:

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

139

docbaseobjectvalidator

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage This control is used only to validate attributes that are listed as ignored attributes in a docbaseattributelist configuration. For example, the list of available formats is displayed by the datadropdownlist control named "formatList" in the Webtop import JSP page, and the user’s selection should be validated against object constraints for the selected object type. The format attribute is listed in the element of import_docbaseattributelist.xml. In order for the selection to be validated, use the validator to validate the control on the JSP page, similar to the following:

docbaseobjectvalidator Purpose Validates all modified attribute control values against all rules that have been set up in the Content server. Renders a list of error messages for all failed validators. This validator is embedded in the docbaseobject control, so validation is performed automatically on attributes that have been modified by the user.

Attributes controltovalidate

(Required) Input control name to validate

cssclass

(Optional) Sets the CSS class that is applied to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

header

(Optional) Header for error message.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

140

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

inputmaskvalidator

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is the error message for validation failure.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

inputmaskvalidator Purpose Validates a control’s input values based on an input mask.

Attributes controltovalidate

(Required) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

141

inputmaskvalidator

errormessage

(Optional) Error message to display when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

inputmask

(Optional) Pattern of valid ASCII characters that the user can enter. This control verifies that the length of the input string is the same number of characters specified in this attribute.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

validatechangeonly

(Optional) Since: 6.0.Indicates whether to validate only when the control changes. True, to validate only when the control changes; False (default), otherwise.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage

An input mask is a pattern of mask characters and literals. A mask character specifies the kind of character allowed at that position in the pattern. A literal is an ASCII character that must appear in

142

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

inputmaskvalidator

the pattern at that position. To convert a mask character to a literal, precede the mask character with a double backslash (\\) . Table 8. Valid Mask Characters

Character

Meaning

#

Numeric (0-9)

A

Alphanumeric (0-9, a-z, A-Z)

&

Any ASCII character

?

Alphabetic (a-z, A-Z)

U

Alphabetic, and converts to uppercase

L

Alphabetic, and converts to lowercase

Masks

This table shows a mask in the first column, an example of valid user input in the second column, and a description of the mask in the last column. The last mask example limits the number of characters to thirteen. Mask

User Input

Description

12/25/1999

Date

12:35 AM

Time

123-45-6789

US social security number (SSN)

(999)555-1212

US phone number

12345-6789

US zip code

John

Name (limited to thirteen characters)

##/##/####

##:## UU

###-##-####

(###)###-####

#####-####

?????????????

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

143

multiobjectsdocbaseattributevalidator

multiobjectsdocbaseattributevalidator Purpose Renders a valildator corresponding to the type of the common attribute of the selected, multiple objects.

Attributes controltovalidate

(Required) Name of the input control to validate.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

multivaluesinputmaskvalidator Purpose Validates multiple values in a label using an input mask.

144

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

multivaluesinputmaskvalidator

Attributes controltovalidate

(Required) Name of the control to validate

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message displayed when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

inputmask

(Optional) Pattern of valid ASCII characters that the user can enter. This control verifies that the length of the input string is the same number of characters specified in this attribute. For more information, see .

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

separator

(Optional) Character to separate input values.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

145

multivaluesrequiredeldvalidator

multivaluesrequiredeldvalidator Purpose Validates that all of the required values in a list box have been set

Attributes controltovalidate

(Required) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

indicator

(Optional) String to display next to a required field. If this attribute is empty (that is, indicator = ""), an asterisk (*) is displayed. Default is an asterisk (*).

indicatorcssclass

(Optional) Class in a stylesheet to apply to the indicator.

indicatornlsid

(Optional) NLSID that resolves to a string to display as a required field indicator.

indicatorstyle

(Optional) CSS style rule to apply to the indicator.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

146

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

quotevalidator

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

quotevalidator Purpose Tests the string contents of an input control for single ( ’ ) or double quotation marks ( " ). Returns true, if the string does not contain a quotation mark or the string is empty; returns false, if the string contains a quotation mark.

Attributes controltovalidate

(Optional) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) The error message to display when validation fails.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

147

rangevalidator

ignore

(Optional) Whether to ignore a single quote or double quotes in the string. Valid values: singlequote, doublequote, or an empty string (default). For example, if you want to test for double quotes only, set the value of this attribute to singlequote. An empty string means that neither double quotes nor single quotes are ignored.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

rangevalidator Purpose Validates an input control by ensuring that its value is within a specified range.

148

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

rangevalidator

Attributes controltovalidate

(Required) Control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

maxvalue

(Optional) The range’s maximum value.

maxvaluecontrol

(Optional) Input control containing the range’s maximum value.

minvalue

(Optional) The range’s minimum value.

minvaluecontrol

(Optional) Input control containing the range’s minimum value.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

type

(Optional) Datatype of the value. Valid values are: string, integer, double.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

149

regexpvalidator

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

regexpvalidator Purpose Verifies that the input control value matches the specified Apache regular expression pattern. For information about Apache expression syntax, see the Apache Web site.

Attributes controltovalidate

(Required) Control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

expression

(Required) Regular expression to match.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

150

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

requiredeldvalidator

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

requiredeldvalidator Purpose Validates an input control by ensuring that its value has been set.

Attributes controltovalidate

(Required) Control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

indicator

(Optional) String to display next to a required field. If this attribute is empty (that is, indicator = ""), an asterisk (*) is displayed. Default is an asterisk (*).

indicatorcssclass

(Optional) Class in a stylesheet to apply to the indicator.

indicatornlsid

(Optional) NLSID that resolves to a string to display as a required field indicator.

indicatorstyle

(Optional) CSS style rule to apply to the indicator.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

151

symbolicversionlabelvalidator

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

symbolicversionlabelvalidator Purpose Ensures that the symbolic version label entered by the user is not an implicit version label.

Attributes controltovalidate

(Required) Name of the control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

152

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

utf8stringlengthvalidator

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is the error message for validation failure.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

utf8stringlengthvalidator Purpose Verifies that the string in its UTF8 representation does not exceed the field limit, to prevent data loss when accented or double-byte characters are entered. Converts the user input string value to its corresponding UTF-8 byte array before comparing it with the specified maximum byte length value.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

153

utf8stringlengthvalidator

Attributes controltovalidate

(Required) Control to validate.

cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

errormessage

(Optional) Error message to display when validation returns false.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

maxbytelength

(Required) Maximum length (in byles) of the UTF-8 byte array corresponding to the user input string.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the errormessage attribute value.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

154

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

validationsummary

Usage This validator can be used to replace the regexpvalidator to validate that string character length confirms to the field size constraint in the data dictionary. For multi-byte and accented characters, the regexpvalidator cannot do this validation and can result in data loss. For example, the checkin page allows the user to enter a version label that, according to the data dictionary, must be no longer than 32 single-byte characters. This validator will not allow a version label that exceeds 32 bytes.

validationsummary Purpose Displays a summary list of failed validation messages for all validated input controls.

Attributes cssclass

(Optional) CSS class to apply to this control.

header

(Optional) Summary header message.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID for the summary header message string.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control. For example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

Description Since 5.x

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

155

dateinput

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Date/time dateinput Purpose Generates a date input control. The order (day and month) will be determined by the user’s locale. The months and days will be listed as integers and their labels are looked up in the localization bundle form.control.DateInputNlsProp.

Attributes cssclass

(Optional) CSS class to apply to this control.

dateformat

(Optional) Format of the date displayed in the user interface. Valid values are: short (for example, 1/2/02), medium (for example, 2 Jan, 2002), long (for example, 2 January, 2002).

dateselector

(Optional) Date selection user interface item. Valid values are: fields (dropdown fields), calendar (a popup calendar). Default is calendar.

day

(Optional) Default day to display. Default is 1.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

fromyear

(Optional) Year to begin the available date range. Default is 1997.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

month

(Optional) Default month to display. Default is 1.

156

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

dateinput

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Specifies for the onselect event to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

toyear

(Optional) Year to end the available date range. Default = 2005.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

157

dateinput

width

(Optional) Width (in pixels) of the control. Default is 200.

year

(Optional) Default year to display. By default, the fromyear attribute value is displayed.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage In addition to the configuration available on individual date controls, global date input display can be configured by extending /wdk/config/datetimecontrol_config.xml. The following table describes date input control configuration in this file:0 Table 9. Global date input control conguration elements



Configures all instances of dateinput tag including those generated by the docbaseattributelist control. Can be overridden on an individual tag. Contains <default-year-from>, <default-year-to>, and <default_type>.

.<default-year-from>

Sets the default beginning year in the date input dropdown list

.<default-year-to>

Sets the default end year in the date input dropdown list

Editable attributes are rendered as dateinput controls. To configure the rendered control, set the beginning and end year in the element of /wdk/app.xml. When you want to set a date programmatically in your component class, clear the dateinput control by calling clear(), which clears day, month, and year. For example: private void resetDateInputControl(DateInput date) { if (date != null) { date.clear(); }

158

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datetime

}

datetime Purpose Generates a date/time control that allows the user to select month, day, year, hour, minute, and second. The date and time labels are looked up in the localization bundle form.control.DateTimeNlsProp.

Attributes cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides all of the date and time values with data from a data source.

dateformat

(Optional) Format of the date displayed in the user interface. Valid values are: short (for example, 1/2/02), medium (for example, 2 Jan, 2002), long (for example, 2 January, 2002).

dateselector

(Optional) Date selection user interface item. Valid values are: fields (dropdown fields), calendar (a popup calendar). Default is calendar.

day

(Optional) Default day to display. Default is 1.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

fromtime

(Optional) Time to begin a range when the timeselector value is list; for example: hh:mm:ss

fromyear

(Optional) Year to begin the available date range. Default is 1997.

hour

(Optional) Default hour to display. Default is the current time.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

159

datetime

minute

(Optional) Default minute to display. Default is the current time.

month

(Optional) Default month to display. Default is 1.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Specifies for the onselect event to run on the client (True) or the server (False).

second

(Optional) Default second to display. Default is the current time.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

timeformat

(Optional) Specifies how the time is formatted in the user interface and the control value (in locale-specific format). Valid values: short (for example, rendered as 2:40 PM in English locale), medium (for example, 2:40:23 PM), long (for example, 2.40:23 PM PST)

160

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datetime

timeselector

(Optional) Time selection user interface item. Valid values are: fields (Default) Dropdown lists that display hour, minute, and day. Increments are set by the value of the timestep attribute. list Single dropdown list of discrete times displayed as the values for timeformat, fromtime, totime, and timestep. text Text box that accepts text input of any kind.

timestep

(Optional) Iincrement (in seconds) between times that are displayed when the timeselector attribute value is list or fields. If the timeselector value is fields and the timestep value is a multiple of 60 or 3600, the seconds and minutes fields are not hidden. Default is 1800.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

totime

(Optional) Time to end a range when the timeselector attribute value is list; for example, hh:mm:ss.

toyear

(Optional) Year to end the available date range. Default is 2005.

visible

(Optional) (Boolean) Whether the control is rendered as visible (True) or hidden (False).

width

(Optional) Width (in pixels) of the control. Default is 200.

year

(Optional) Default year to display. By default, the fromyear attribute value is displayed.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

161

datetime

Usage In addition to the configuration available on individual date controls, global date display can be configured by extending /wdk/config/datetimecontrol_config.xml. The following table describes datetime control configuration in this file: Table 10. Global datetime control conguration elements



Sets the default date format type for all instances of the datetime control, including those generated by docbaseattributelist control. Overridden by the dateformat and timeformat attributes on the datetime control.

.<default_type>

Specifies the type of Java DateFormat to apply (examples in parentheses). Valid values: short (12.13.52 or 3:30 pm) medium (Jan 12, 1952 3:30 pm) long (January 12, 1952 3:30:32 pm) full (Tuesday, April 12, 1952 AD 3:30:42 pm PST)

When you want to set a date and time programmatically in your component class, clear the datetime control by calling clear(), which clears day, month, and year. For example: private void resetDateTimeControl(DateTime dt) { if (dt != null) { dt.clear(); } }

Not all fields must be set for the control to be valid. The following table shows the state of each field and whether the combined state returns true for isValid(), isValidDate(), isValidTime(), and the value that will be displayed: Yr/Mo/ Day

Hour

Min

Sec

not set

isValid

isValid Date

isValid Time

Value

F

F

F

blank

all set

null

set

set

F

T

F

blank

all set

null

null

set

F

T

F

blank

all set

set

null

set

F

T

F

blank

all set

null

null

null

T

T

F

date,00: 00:00

all set

set

null

null

T

T

T

date, hr: 00:00

162

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datevalueformatter

Yr/Mo/ Day

Hour

Min

Sec

isValid

isValid Date

isValid Time

Value

all set

set

set

null

T

T

T

date, hr: min:00

all set

set

set

set

T

T

T

date, hr: min:sec

datevalueformatter Purpose Datevalueformatter control. Wraps a raw date value in milliseconds since 1970 and replaces the value with a formatted date value.

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

type

(Optional) Format of the date to display. Maps to the Java DateFormat types; such as "short, "medium, "long, "full.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

163

dragdrop

Usage Table 11. Global datetime control conguration elements



Sets the default date format for all instances of the datevalueformatter control. Overridden by the type attribute on the datevalueformatter control.

.<default_type>

Specifies the type of Java DateFormat to apply (examples in parentheses). Valid values: short (12.13.52 or 3:30 pm) medium (Jan 12, 1952 3:30 pm) long (January 12, 1952 3:30:32 pm) full (Tuesday, April 12, 1952 AD 3:30:42 pm PST)

Deprecated controls Drag and drop dragdrop Purpose Indicates that one or more dragdropregion tags, or controls that implement drag and drop interfaces, are defined on the page

Attributes None.

Description Since 5.x

164

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

dragdropregion

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage To support drag and drop on the page, add the dragdrop tag to the page and a dragdropregion tag that contains controls to support a drag or drop (or both) operation. If you have a browsertree in your page, you do not need a dragdrop region tag: the browsertree control has an ondrop attribute. For more information about drag and drop, see Web Development Kit Development Guide.

dragdropregion Purpose Specifies that the contained control or controls support drag and/or drop operations. The specific operations are named in the control attributes.

Attributes cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides label or NLS value with string from a data source

dragenabled

(Optional) Whether dragging the control is supported (True) or not (False).

dragenableddatafield

(Optional) Alternative method of specifying whether the control supports dragging. The value of the attribute is used as a key to retrieve whether dragging of the control is supported.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

enableddroppositions

(Optional) Drop positions that are supported by the control. Valid values is a comma separated combination of above, below, and over.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

165

dragdropregion

enableddroppositionsdatafield

(Optional) Alternative method of specifying the type of drop positions that is supported. The value of the attribute is used as a key to retrieve the action drop positions.

focus

(Optional) Whether this control accepts focus (True) or not (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

isbackground

(Optional) Whether the dragdrop region is the page background (True) or not (False).

label

(Optional) Label for dragdrop region.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

ondrop

(Optional) Specifies the name of a method that handles the ondrop event. You must enter a value here and set a value for enableddroppositions to enable drop operations.

ondropdatafield

(Optional) Alternative method of specifying the name of the drop handler function. The value of the attribute is used as a key to retrieve the actual drop handler function

runatclient

(Optional) Whether the ondrop event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

166

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

dragdropregion

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether the control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage To support drag and drop on the page, add the dragdrop tag to the page and a dragdropregion tag that contains controls to support a drag or drop (or both) operation. If you have a browsertree in your page, you do not need a dragdrop region tag: the browsertree control has an ondrop attribute. To enable drop operations, set an ondrop event handler for the ondrop attribute and specific one or more supported drop positions for the enableddroppositions attribute. To enabled drag operations, set the dragenabled attribute to true. You can enable both operations for a region. Following are some examples of drag and drop regions: •

label in clipboard.jsp dragenabled=’true’

•

datagrid in /rooms/doclist_body.jsp enableddroppositions="<%=IDropTarget.DROP_POSITION_OVER%>" ondrop=’onDrop’ Note: This dragdropregion tag contains another nested dragdropregion tag that enabled drag

•

link in vdmlist_streamline.jsp ondrop=’onDrop’ enableddroppositions=’above,over,below’ dragenabled=’true’

For more information about drag and drop, see Web Development Kit Development Guide.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

167

form

Explorer Framework form Purpose Generates an HTML form on a Web page.

Attributes enctype

(Optional) Form data encoding type. Valid values are: multipart/form-data | application/x-www-form-urlencoded | text/plain. Set to "multipart/form-data on pages that upload file content such as check in, import and import rendition.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

keepfresh

(Optional) Whether to keep the form refreshed (True) or not (False). If the browser loads the form without sending a request back to the server (for example, when the user hits the Back button) a server post-back event is generated to render the component again. If the component is within a container, the container URL is refreshed.

168

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

webform

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onkeepfresh

(Optional) JavaScript (client-side) event handler for the keepfresh event that is triggered when the user hits the Back button. In the Form class implementation, this method provides a URL for the refresh event. Your handler can override this implementation.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

webform Purpose Outermost tag containing all other taglib tags on a page. This represents the entire HTML page. Generates included JavaScript file references.

Attributes formclass

(Optional) Java class containing the event handler functions that are called when events are fired. If the JSP page is in a component, do not specify this attribute, because the component class handles events.

nlsbundle

(Optional) NLS bundle that is used by all the controls in the form. If the JSP page is in a

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

169

reclientevent

component, the component class specifies the nlsbundle attribute value. nlsclass

(Optional) Java NLS class that is used by all the controls in this form. If the JSP page is in a component, the component class specifies the nlsclass attribute value.

validation

(Optional) Whether to prevent (False) validation of controls on the form or not (True). Default is true. Only set to false when in development.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Generating client and server events reclientevent Purpose Fires a client JavaScript event when the JSP page is loaded. Can contain one or more controls to pass values to the event handler. Used by the application integrations framework.

Attributes enabled

(Optional) Whether this control is enabled (True) or disabled (False).

event

(Required) Name of an event handler on the client.

170

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

represubmitclientevent

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

includeargname

(Optional) Whether to pass event argument names and values to the handler (True) or only the value to the handler (False). Default is false.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

represubmitclientevent Purpose Fires a client JavaScript event before submitting the control event to the server. Can contain one or more controls to pass values to the event handler. Used by the application integrations framework.

Attributes controlid

(Optional) Name of the control for which to fire the event. The event is fired for any control onclick event. If this attribute’s value is not specified (default), then the client event is fired before form submission.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

171

postserverevent

event

(Required) Name of an event handler on the client. If a controlid is specified, the event fires only for the named control.

id

(Optional) ID for this control. The ID is generated by the framework. You can also set the ID in the JSP page.

includeargname

(Optional) Whether to pass event argument names and values to the handler (True) or only the value to the handler (False). Default is false.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

postserverevent Purpose Renders a postServerEvent() JavaScript call to a method in a class on the J2EE application server. This tag is used within a JavaScript function.

Attributes clientsidehandlermethod

(Optional) (WDK for Portlets only) Name of the client side JavaScript handler function.

controlid

(Optional) ID of the control that fires the event.

172

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

postserverevent

eventargname

(Optional) Name of an argument to be passed to the method specified in the handlermethod attribute. The argument value to be passed is specified in the eventargvalue attribute.

eventargname2

(Optional) Name of an argument to be passed to the method specified in the handlermethod attribute. The argument value to be passed is specified in the eventargvalue2 attribute.

eventargname3

(Optional) Name of an argument to be passed to the method specified in the handlermethod attribute. The argument value to be passed is specified in the eventargvalue3 attribute.

eventargname4

(Optional) Name of an argument to be passed to the method specified in the handlermethod attribute. The argument value to be passed is specified in the eventargvalue4 attribute.

eventargvalue

(Optional) Value of an argument to be passed to the method specified in the handlermethod attribute. The argument name is specified in the eventargname attribute.

eventargvalue2

(Optional) Value of an argument to be passed to the method specified in the handlermethod attribute. The argument name is specified in the eventargname2 attribute.

eventargvalue3

(Optional) Value of an argument to be passed to the method specified in the handlermethod attribute. The argument name is specified in the eventargname3 attribute.

eventargvalue4

(Optional) Value of an argument to be passed to the method specified in the handlermethod attribute. The argument name is specified in the eventargname4 attribute.

formid

(Optional) ID of the current form, for example, ’<%=form.getElementName()%>’

handlerid

(Optional) ID of the control that handles the event.

handlermethod

(Optional) Server method to be called. Required for standalone Web application; optional for WDK for Portlets.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

173

clientenvpanel

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The following example from advsearchex.jsp renders a JavaScript function call to postServerEvent(), which in turns calls the event handler executeSavedSearch() in the AdvSearchEx class. The class containing the event handler must be imported in the JSP page:: <%@ page import="com.documentum.webcomponent.library.advsearch.AdvSearchEx" %> ... function executeSavedSearch() { }

Grouping user interface elements clientenvpanel Purpose Generates a panel that is displayed or hidden depending on the client environment. For example, the WDK login JSP page has one panel for the Application Connectors environment and another one for the non-connector environment.

174

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

clientenvpanel

Attributes environment

(Optional) String that specifies the client environment, which is specified in the application/environment/clientenv element of the app.xml.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

reversevisible

(Optional) Whether the panel is visible (False) or the reverse of the current visibility state (True) of the environment specified by the environment attribute. You can usually set this attribute to true to hide the panel. Default is false.

Description Since 5.x

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

Usage Your application can display different content depending on whether the client is using a Application Connector within a Microsoft Office application. For example, the WDK login page contains two login buttons. The button for the non-connector environment specifies a server-side event handler as follows:

The button for the connector environment specifies an event handler on the client opens a browser window for the application connector: <script> function onLogin() { try

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

175

pane

{ window.external.AppIntgProcessEvent("event=OnLogin"); } ... postServerEvent(null, null, null, "onLogin"); } ...

pane Purpose Pane control contained within a paneset control. Displays content that can be fixed or scrolled. For information about general scrollable paneset design, see Web Development Kit Development Guide.

Attributes id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name for this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

overflow

(Optional) Whether to generate a scroll bar (auto) or clip excessive content (hidden), if the content exceeds the scrolling area. Default is auto. Specify hidden for fixed panes, such as headers and footers.

printable

(Optional)

176

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

panel

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

panel Purpose Panel control that wraps a group of controls as a mechanism for hiding or displaying the group.

Attributes datafield

(Optional) Overrides the visible attribute value.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

mode

(Optional) Whether the datafield attribute value is a string or boolean. Default is string. If this attribute value is string and the datafield value’s string length is greater than 0, then the datafield attribute value is true. If this attribute value is boolean and the datafield attribute value is 1, T, or true, then the datafield attribute value is true.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

177

panel

reversevisible

(Optional) Whether the visible attribute is the boolean complement of the datafield attribute value (True) or not (False). Default is false. For example, when this attribute is set to true and the datafield value (in boolean mode) is true, then the visible attribute value is false.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage Panels can be used to display or hide elements within the JSP. For example, the newnotepage component hides a panel in onInit(): Panel panel = (Panel) getControl("optionspanel", Panel.class); panel.setVisible(false);

The panel is then displayed in onClickShowHideOptions(), which is called when the user clicks the Show/Hide options checkbox: Panel panel = (Panel) getControl("optionspanel", Panel.class); if (m_bShowOptions == true) { panel.setVisible(true); linkShowHideOptions.setLabel(getString("MSG_HIDE_OPTIONS")); } else { panel.setVisible(false); linkShowHideOptions.setLabel(getString("MSG_SHOW_OPTIONS")); }

The options panel and link that makes it visible are coded in the JSP page is as follows:

, . Displays the contents of its databound controls for all rows of data that are available or that are shown per page. 104 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide datagridRow Attributes align (Optional) Horizontal alignment of the cell. altclass (Optional) Class for alternating lines (if required); for example: altclass= ’databoundExampleDatagridRowAlt’ altstyle (Optional) CSS rule for alternating lines (if required); for example: columns (Optional) Number of columns in which to display the data. If this value is greater than zero, then the datagrid formats the data in the specified number of columns. cssclass (Optional) CSS class to apply to this control. height (Optional) Height of the datagrid. id (Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page. name (Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed. style (Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" tooltip (Optional) String that displays as a title for each row. tooltipdatafield (Optional) NLSID element that displays as a title for each row. tooltipnlsid (Optional) Datafield that displays as a title for each row. valign (Optional) Vertical alignment of the cell. width (Optional) Width of the datagrid. EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 105 datagridRowBreak Description Since 5.x Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) Usage The number of rows displayed depends on data set size and paging options set on the parent datagrid tag. When the accessibility option is turned on in the user preferences, the datagridrow tag generates a title for the row based on the tooltip. This allows reader programs to navigate the generated rows of data. Use only one datagridRow tag within a datagrid. datagridRowBreak Purpose Specifies a break in a DatagridRow control. Attributes align (Optional) Alignment of cells in the row (left, right, center, justify, or char) altclass (Optional) Sets the class for alternating lines if required; for example: altclass= ’databoundExampleDatagridRowAlt’ altstyle (Optional) CSS rule for alternating lines,if required; for example: bgcolor (Optional) Background color for the cells in the row. 106 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide datagridRowBreak char (Optional) Specifies a single character within a text fragment to act as an axis for alignment. The default value for this attribute is the decimal point character in HTML documents for the current language as set by the lang attribute (for example, the period (.) in English and the comma (,) in French). charoff (Optional) Specifies the offset to the first occurrence of the alignment character on each line. If a line does not include the alignment character, it will be horizontally shifted to end at the alignment position. cssclass (Optional) Sets the cascading style sheet class that is used to format the control. dir (Optional) Specifies the direction for the text as left-to-right (LTR) or right-to-left (RTL). height (Optional) Not used. id (Optional) ID for the control. The ID is generated by the framework. You can also set the ID in the JSP. lang (Optional) Language code, used to assist third-party software (such as, spelling and grammar checkers). style (Optional) A cascading style sheet rule enclosed in quotation marks; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" title (Optional) Title attribute for the row. valign (Optional) Vertical alignment setting for cells in the row. Description Since 6.0 Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 107 datagridRowEvent datagridRowEvent Purpose Specifies the event for which to register and the event handler in a DatagridRow control. Attributes action (Optional) ID of the action to be launched by this control. eventhandler (Optional) Name of the handler for the event. eventname (Required) Name of the event for which to register. runatclient (Optional) Specifies for the event to run on the client (True) or the server (False). Description Since 6.0 Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) Usage This control is disabled when its parent datagrid control’s rowselection attribute is true. datagridRowModier Purpose Hides or disables contained controls when its parent datagrid’s rowselection attribute is true. 108 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide datagridRowTd Attributes skipbody (Optional) Description Since 6.0 Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) datagridRowTd Purpose Data cells in a datagrid control. Outputs	HTML tags with a marker class. Attributes abbr (Optional) HTML abbr attribute. align (Optional) HTML align attribute. axis (Optional) HTML axis attribute. bgcolor (Optional) HTML bgcolor attribute. char (Optional) HTML char attribute. charoff (Optional) HTML charoff attribute. colspan (Optional) HTML colspan attribute. cssclass (Optional) CSS class to apply to this control. dir (Optional) HTML dir attribute. headers (Optional) HTML headers attribute. height (Optional) HTML height attribute. EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 109 datagridTh id (Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page. lang (Optional) HTML lang attribute. nowrap (Optional) HTML nowrap attribute. rowspan (Optional) HTML rowspan attribute. scope (Optional) HTML scope attribute. style (Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" title (Optional) HTML title attribute. valign (Optional) HTML valign attribute. width (Optional) HTML width attribute. Description Since 6.0 Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) Usage Place inside of a datagridRow control in a datagrid control. At runtime, if the number of data columns does not match the number of column head cells, an error is generated. datagridTh Purpose Column heads in a datagrid control. Outputs	HTML tags with a marker class and HTML tags that constrain each cell’s content. 110 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide datagridTh Attributes abbr (Optional) HTML abbr attribute. align (Optional) HTML align attribute. axis (Optional) HTML axis attribute. bgcolor (Optional) HTML bgcolor attribute. char (Optional) HTML char attribute. charoff (Optional) HTML charoff attribute. cssclass (Optional) CSS class to apply to this control. dir (Optional) HTML dir attribute. headers (Optional) HTML headers attribute. height (Optional) HTML height attribute. id (Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page. lang (Optional) HTML lang attribute. nowrap (Optional) HTML nowrap attribute. resizable (Optional) Boolean: Whether to enable the ability to resize the column head (True) or not (False). Default is false. Since 6.0. rowspan (Optional) HTML rowspan attribute. scope (Optional) HTML scope attribute. style (Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" title (Optional) HTML title attribute. valign (Optional) HTML valign attribute. width (Optional) HTML width attribute. Description Since 6.0 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 111 dataoptionlist Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) Usage Place this control inside of a datagrid control in the first
; col1 (Optional) Specifies an HTML string to render between the label and value. Scripts are not supported. Default ==	 	col2 (Optional) Specifies an HTML string to render between the value and validator. Scripts are not supported. Default ==	cssclass (Optional) Sets the cascading style sheet class that is used to format the control. id (Optional) ID for the control. The ID is generated by the framework. You can also set the ID in the JSP. 122 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide datatablerowattributelist morelinkpost (Optional) Specifies an HTML string to render after the Show More link. Scripts are not supported. Default ==
name (Optional) Sets the name for the control. Named controls are cached on the server. Controls with the same name are automatically indexed. object (Required) Name of associated docbaseobject control on the JSP page. post (Optional) Specifies an HTML string to render after each docbaseattribute control. Scripts are not supported. Default ==
readonly (Optional) Set to true to display attributes as read-only. This setting does not override or change the status of the attributes in the repository; it only applies to the rendering of the attribute inthe UI. The value of readonly == "false" can be overridden by the attributes component readOnly parameter. separator (Optional) Specifies HTML to render as a separator between attributes. Default ==
tags and content within the opening and closing nodatarow tags. EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 129 row Attributes align (Optional) Horizontal alignment of the cells. cssclass (Optional) CSS class to apply to this control. height (Optional) Height of the row. id (Optional) ID for this control. The ID is generated by the framework. You can also set the ID in the JSP page. name (Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed. style (Optional) CSS rule (enclosed in quotation marks, for example: style="{COLOR: darkmagenta; TEXT-DECORATION: underline}") to apply to this control. valign (Optional) Vertical alignment of the cells. Description Since 5.x Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) row Purpose Generates a static header or footer HTML table row inside the data grid control. Adds the static data row above or below the dynamic datagridrows. Can be used in place of

<% /* Options */ %>

178 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide paneset

paneset Purpose Contains pane controls to allow scrolling, so that buttons stay in view and content within a pane is scrolled. One outermost paneset to a JSP page, which can contain nested panesets. For information about general scrollable paneset design, see Web Development Kit Development Guide.

Attributes bottompadding

(Optional) Bottom padding (in pixels) of the paneset control. Applies only to the outermost paneset control in a page.

cols

(Optional) Width for the contained panes; for example, cols=’110, *, 40’. The asterisk (*) indicates that the middle pane uses the remaining browser space. You must specify either rows or columns, but not both.

cssclass

(Optional) CSS class to apply to this control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

leftpadding

(Optional) Left padding (in pixels) of the paneset control. Only valid for the outermost paneset control in a page.

minheight

(Optional) Minimum height (in pixels) of the paneset control. Only valid for the outermost paneset control in a page.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

179

paneset

minwidth

(Optional) Minimum width (in pixels) of the paneset control. Only valid for the outermost paneset control in a page.

name

(Required) Name for this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

rightpadding

(Optional) Right padding (in pixels) of the paneset control. Only valid for the outermost paneset control in a page.

rows

(Optional) Height (in pixels) for the contained panes; for example, rows=’110, *, 40’. The asterisk (*) indicates that the middle pane uses the remaining browser space. You must specify either rows or columns, but not both.

toppadding

(Optional) Top padding (in pixels) of the paneset control. Only valid for the outermost paneset control in a page.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage Controls on the JSP page that are outside the dmf:paneset control may not be visible. If you are displaying data from a datagrid in multiple panes, set the rendertable attribute to false so that the datagrid does not render markup. Instead, manually add start and close tags within your tags. You can globally configure all paneset controls in your application by extending the paneset configuration file /wdk/config/panesetcontrol_config.xml. The following attributes can be globally configured for the outermost paneset and the inner panesets independently: toppadding, bottompadding, leftpadding, and rightpadding.

180

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

tab

tab Purpose Generates a tab control within a tabbar control.

Attributes datafield

(Optional) Overrides value and NLS ID with data from a data source.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

height

(Optional) Height of the tab and overrides the tabheight property in the tabbar control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the value attribute value.

onchange

(Optional) Event that is fired after the user changes the tab. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Whether the onclick event is to run on the client (True) or the server (False).

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

181

tabbar

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) Text that is displayed on the tab.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Width of the tab and overrides the tabwidth property in tabbar.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

tabbar Purpose Generates a tab bar control (non-graphical).

Attributes align

(Optional) Alignment of the text on all of the tabs. Valid values are: left, right, center. Default is center.

cssclass

(Optional) CSS class to apply to this control.

disabledclass

(Optional) CSS class to apply to the text of disabled tabs.

disabledstyle

(Optional) Entire CSS-syntax style sheet rule (enclosed in quotes) to apply to the text of the disabled control.

182

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

tabbar

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

imagefolder

(Optional) Folder in which the tab bar graphics are stored. If the graphics are not found in this folder, a non-graphical tab bar is displayed.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

normalclass

(Optional) Class to apply to text of normal tabs.

normalstyle

(Optional) Style to apply to text of normal tabs.

onchange

(Optional) Event fired when a user selects a tab. This event is not handled immediately. It is handled on the server only when the form is submitted.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Whether the onclick event is to run on the client (True) or the server (False).

scrollable

(Optional) Whether to enable scrolling through tabs if all tabs are not visible within the browser page (True) or not (False). Default is false. Supported only when the tabposition attribute value is top (for both graphical and non-graphical tab bars). Container must define a width (paneset, table). Scrolling arrow images (chevrons) can be placed in tabbar image folder for a theme.

selectedclass

(Optional) Class to apply to text of selected tabs.

selectedstyle

(Optional) Style to apply to text of selected tabs.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

183

tabbar

showtabs

(Optional) Whether to display tabs (True) or non-clickable, non-graphic roadmap for use in wizard containers only (False). Default is true. If this attribute is set to false, the values of these attributes are ignored for rendering: tabposition, imagefolder, and onclick.

tabheight

(Optional) Height of all the tabs. Default is 10. Use the height property on a tab to override this attribute.

tabposition

(Optional) Position of the tabs on the page. Valid values are: top, bottom, left, right. Default is top.

tabwidth

(Optional) Width of all the tabs. Default is 60. Use the width property on a tab to override this attribute.

value

(Optional) Text displayed on the selected tab. Sets the name of the initial tab.

visible

(Optional) (Boolean) Whether this control is rendered as visible (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage You can add scolling arrows (chevrons) to a theme. The images must be in the folder /theme_name/images/tabbar/top where theme_name is the name of your theme. The images must have the following names: backward_enabled.gif, backward_disabled.gif, forward_enabled.gif, and forward_disabled.gif. Note: To have a scrollable tabbar, the containing HTML element must have a fixed width. For example, the containing table cells in Webtop’s tabbar.jsp set fixed widths as follows:

The Webtop streamline view has its own set of images. The images must be in the folder /theme_name/imagesstreamline/tabbar/top where theme_nameis the name of your theme. The images must have the following names: backward_enabled.gif, backward_disabled.gif, forward_enabled.gif, and forward_disabled.gif.

HTML body Purpose Generates an HTML tag.

Attributes alink

(Optional) HTML alink attribute.

background

(Optional) HTML background attribute.

bgcolor

(Optional) HTML bgcolor attribute.

bottommargin

(Optional) Distance (in pixels) between the body text and browser window bottom margin.

cssclass

(Optional) CSS class that is applied to this control.

dir

(Optional) HTML dir attribute.

height

(Optional) HTML height attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lang

(Optional) HTML lang attribute.

leftmargin

(Optional) Distance (in pixels) between the body text and browser window left margin.

link

(Optional) HTML link attribute.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

185

body

marginheight

(Optional) HTML marginheight attribute.

marginwidth

(Optional) HTML marginwidth attribute.

onload

(Optional) JavaScript event handler for the HTML body onload event.

onunload

(Optional) JavaScript event handler for the HTML body onunload event.

rightmargin

(Optional) Distance (in pixels) between the body text and browser window right margin.

showdialogevent

(Optional) Whether to allow the page to be rendered in an Application Connector dialog window (True) or not (False).

sizepreference

(Optional) Whether to save the user’s resize preference for an Application Connector dialog window (True) or not (False). Default is true.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

text

(Optional) HTML text attribute.

title

(Optional) HTML title attribute.

titlenlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the title attribute value.

topmargin

(Optional) Distance (in pixels) between the body text and browser window top margin.

vlink

(Optional) HTML vlink attribute.

width

(Optional) HTML width attribute.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

186

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

button

button Purpose Generates an HTML button.

Attributes accessible

(Optional) Deprecated in 6.0.Whether accessible mode is on (True) or off (False). (Only used with the imagefolder attribute)

align

(Optional) Deprecated in 6.0.6.0: This attribute is ignored.Pre-6.0: (Image label only) Alignment of the label text.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides label or nlsid with data from a data source.

default

(Optional) Whether this button is the default button on the page (True) or not (False). Must be used with a text control or another control that has the defaultonenter attribute set to true. When the user presses the Enter key, the default button event is fired.

disabledclass

(Optional) Deprecated in 6.0. CSS class to apply to the disabled control.

disabledstyle

(Optional) Deprecated in 6.0. Entire CSS-syntax style sheet rule (enclosed in quotes) to apply to the disabled control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

height

(Optional) Height of the image.

hotkeyid

(Optional) Value of a id attribute in the hotkeys configuration file (hotkeys.xml, located in /webcomponent/config) that references the keyboard shortcut command string for this control.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

187

button

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

imagefolder

(Optional) Deprecated in 6.0.6.0: Sets the folder that the button graphics are stored in. If the graphics are not found in this folder or this attribute is not specified, then an HTML button is rendered.Pre-6.0: Sets the folder that the button graphics are stored in. If graphics are not found in this folder, an HTML button will be drawn.

label

(Optional) Value stored in the control and displayed as text on the button.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

onchange

(Optional) Event fired when this control is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onclick

(Required) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Whether the event is to run on the client (True) or the server (False).

src

(Optional) Image to be used for the button.

srcdisabled

(Optional) Image to be used when the button is disabled.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

188

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

button

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipdatafield

(Optional) Datafield that overrides the value of tooltip and tooltipnlsid.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Width of the image.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage In pre-6.0, by default, this control rendered the HTML tag; if the imagefolder attribute was specified, then the

184 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide body

......

xxxLABELxxx

HTML tags were rendered; if the src attribute was specified then the HTML tag was rendered.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

189

checkbox

In 6.0, by default this control renders the tag; using the imagefolder attribute and its associated attributes (disabledstyle, disabledclass, align, accessible) are deprecated. Also, specifying the src attribute renders the ... HTML tags.

checkbox Purpose Generates an HTML checkbox form control.

Attributes cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides value with data from a data source

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether this control accepts focus (True) or not (False).

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Text label for the checkbox.

labelalign

(Optional) Alignment of the checkbox label. Valid values are: left, right

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

190

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

checkbox

onchange

(Optional) Event fired when this control is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Whether the onclick event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) Whether the control is checked (True) or unchecked False). Default is false.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

191

datadropdownlist

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The checkbox supports the onclick event for which you must implement your own server side event handler. Checkbox also supports an onchange event that is fired when the form is resubmitted.

datadropdownlist Purpose Generates an HTML drop down list control. Holds option tags or a single dataoptionlist control that contains a databound option tag.

Attributes autocompleteenabled

(Optional) (Boolean) Enables (True) or disables (False) autocompletion on the control. Default is True.

autocompleteid

(Optional) Key that is used to store the autocomplete list in the user preferences. You can set the same ID on two text controls, for example, if they share the same set of suggestions. If the control has no ID specified, the ID will be generated based on the form id and text control name, in the form consisting of formid_controlid. For docbaseattribute controls that render a text control, an ID is generated using the attribute name, for example, keyword or title.

cssclass

(Optional) CSS class to apply to this control.

192

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datadropdownlist

editable

(Optional) Whether the user can type in a value (True) or not (False).

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether to accept focus (True) or not (False).

id

(Optional) ID ofthis control. The ID is generated by the framework. You can also set the ID in the JSP page.

maxautocompletesuggestionsize

(Optional) Number of matching suggestions to display to the user. Default is 10.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). The form is not submitted until the onselect event is fired.

query

(Optional) Displays query or recordset as a drop down list. Use dataoptionlist tag within datadropdownlist for databound values. Use the option tag within datadropdownlist for static output. The DQL query that is passed to the data provider has the following form: query="select r_object_id, user_name from dm_user where user_name like ’a%’ "

runatclient

(Optional) Specifies that the onselect event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

193

datadropdownlist

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) The selected value.

visible

(Optional) (Boolean) Whether this control is rendered as visible (True) or hidden (False).

width

(Optional) Horizontal length of the drop down list control.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

194

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

datalistbox

datalistbox Purpose Generates an HTML list box control. Use the dataoptionlist tag within dataoptionlist for databound values. Use the option tag within dataoptionlist for static output.

Attributes cssclass

(Optional) CSS class to apply to this control.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) To accept focus (True) or not (False).

height

(Optional) Vertical length of the drop down list control.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). The form is not submitted until the onselect event is fired.

query

(Optional) DQL query to retrieve data for a dataoptionlist control, for example: query="select r_object_id, user_name from dm_user"

runatclient

(Optional) Specifies that the onselect event is to run on the client (True) or the server (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

195

datalistbox

size

(Optional) Number of rows of selectable data visible in the listbox. Scrollbars are used if more rows are available.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) The selected value.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Horizontal length of the drop down list control.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

196

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

div

div Purpose Generates HTML

open and close tags.

Attributes align

(Optional) HTML align attribute.

cssclass

(Optional) CSS class to apply to this control.

datafld

(Optional) HTML datafld attribute.

dataformatas

(Optional) HTML dataformatas attribute.

datasrc

(Optional) HTML datasrc attribute.

dir

(Optional) HTML dir attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lang

(Optional) HTML lang attribute.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

title

(Optional) HTML title attribute.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

197

dropdownlist

dropdownlist Purpose Generates an HTML drop-down list control. Contains option tags or a single dataoptionlist control that contains a databound option tag.

Attributes autocompleteenabled

(Optional) (Boolean) Enables (True) or disables (False) autocompletion on the control. Default is True.

autocompleteid

(Optional) Key that is used to store the autocomplete list in the user preferences. You can set the same ID on two text controls, for example, if they share the same set of suggestions. If the control has no ID specified, the ID will be generated based on the form id and text control name, in the form consisting of formid_controlid. For docbaseattribute controls that render a text control, an ID is generated using the attribute name, for example, keyword or title.

cssclass

(Optional) CSS class to apply to this control.

datafield

(Optional) Overrides the value attribute with data from a data source.Since 6.0.

editable

(Optional) Whether the user can type in a value (True) or not (False).

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

focus

(Optional) Whether to accept focus (True) or not (False).

forceselection

(Optional) Whether it is required (True) or optional (False) for the user to select an entry from the dropdown box. If true is specified, no item is selected initially. If false is specified, the first item in the list is selected initially.

198

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

dropdownlist

height

(Optional) Vertical length of the drop down list control

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

maxautocompletesuggestionsize

(Optional) Number of matching suggestions to display to the user. Default is 10.

name

(Required) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onselect

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). The form is not submitted until the onselect event is fired.

runatclient

(Optional) Specifies whether the onselect event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

199

dropdownlist

being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0. tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) The selected value.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

width

(Optional) Horizontal length of the drop down list control

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage Options in the list can be set programmatically using the method addOption(). For example: DropDownList dropdown = (DropDownList) get Control ( DOCBASE, DropDownList.class); Option option1 = new Option(); option1.set Value(value1); option1.set Label (value1); dropdown.addOption(option1);

The onchange event does not submit the form, so you cannot use the onchange event to update other lists or controls on the JSP page. If you need to update another control, handle the onselect event in your component class with a method that does nothing, and handle the onchange event with a method that performs the control update. For example: public void onSelectTypeFilter(DropDownList control, ArgumentList args) { String strMode = control.getValue(); // Control update logic here updateControls(); }

200

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

dropdownorlabel

When the dropdown list is rendered for a required attribute value with value assistance, forceselection is set to true and the default value is selected. If the required attribute does not have a default value, no item will be selected and the user will be forced to select an item.

dropdownorlabel Purpose Displays a label if there is only one value to display; otherwise displays a drop-down list.

Attributes enabled

(Optional) Whether this control is enabled (True) or disabled (False).

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

Description Since 6.0

Tag library descriptor dmfx (WEB-INF\tlds\dmformext_1_0.tld)

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

201

frame

frame Purpose Generates HTML tags.

Attributes cssclass

(Optional) CSS class to apply to this control.

frameborder

(Optional) Whether to display a frame border (True) or not (False)

marginheight

(Optional) Height (in pixels) between the frame and browser window margin.

marginwidth

(Optional) Width (in pixels) of the spacing between the frame and browser window margin.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the title attribute value.

noresize

(Optional) Whether to make the frame resizeable (False) or not (True).

scrolling

(Optional) Whether to display scroll bars for the frame (True) or not (False).

src

(Optional) Source of the frame content. Can be URL to component, HTML page, or JSP page (HTML or JSP path must be relative to application root). For example: src=’/component/toolbar’ or src=’/webtop/classic/workarea.jsp’

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

title

(Optional) Title to display for the frame.

202

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

frameset

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

frameset Purpose Generates HTML tags.

Attributes border

(Optional) Border (in pixels) around the image, if the frameborder attribute is set to true. Default is 0 (zero) pixels (that is, no border).

cols

(Optional) Width (in pixels) of each column. Cannot be used with the rows attribute. Use an asterisk (*) to specify that the width is determined by the browser. For example: rows="24,*"

cssclass

(Optional) CSS class to apply to this control.

frameborder

(Optional) Whether to display a frame border (True) or not (False).

framespacing

(Optional) Width (in pixels) of the spacing between frames.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Sets the name for this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

203

head

onload

(Optional) Event to be fired in the frameset onload event.

onunload

(Optional) Event to be fired in the frameset onunload event.

rows

(Optional) Height (in pixels) of each row. Cannot be used with the cols attribute. Use an asterisk (*) to specify that the height is determined by the browser. For example: rows="24,*"

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

head Purpose Generates HTML open and close tags.

Attributes None.

Description Since 5.x

204

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

helpimage

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

helpimage Purpose Renders an image that launches context-sensitive help.

Attributes alttext

(Optional) Text to display when holding the mouse pointer over this control.

border

(Optional) Border (in pixels) around the image. Default is 0 (zero) pixels (that is, no border).

datafield

(Optional) Overrides the value of the src attribute with a URL from a data source.

height

(Optional) Height of this control.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Overrides the alttext and nlsid attribute values.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

205

helpimage

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

src

(Optional) URL to the image on the server. Can be a path on the server or in the repository, for example:src="/webtop/component/getcontent? objectId=0900303980005172"The repository icon may affect performance.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) Width of this control.

Description Since 5.x

206

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

html

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

html Purpose Generates HTML open and close tags.

Attributes doctype

(Optional) Whether the W3C//DTD HTML 4.01 doctype (strict) or the W3C//DTD HTML 4.01 Transitional doctype (empty string) is used. Default is an empty string.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

iconwell Purpose Generates an HTML icon well that displays icons either horizontally or vertically and associates an onclick event with the icon. This control replaces the component tabs in the 5.2.x locator components. Each component that uses an iconwell control must configure it in the component definition.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

207

iconwell

Attributes align

(Optional) Horizontal alignment (the HTML align attribute for the TD element).

border

(Optional) Border (in pixels) around the image, if it is a link. Default is 0 (zero) pixels (that is, no border).

cssclass

(Optional) CSS class to apply to this control.

disabledbgimage

(Optional) Overrides the image specified for the disabled icon background in the component definition.

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

highlightedbgimage

(Optional) Overrides the image specified for the highlighted icon background in the component definition.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

normalbgimage

(Optional) Overrides the image specified for the normal icon background in the component definition.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). When onclick is used, the image is turned into a link.

renderorientation

(Optional) Whether the well of icons is oriented vertically (vertical) or horizontally (horizontal). Default is horizontal.

runatclient

(Optional) Whether the onclick event is to run on the client (True) or the server (False).

208

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

iconwell

selectedbgimage

(Optional) Overrides the image specified for the selected icon background in the component definition.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The iconwell control can be used to render a group of icons that launch actions or components. The set of icons is configured in the definition file for the component that includes an iconwell tag. This allows you to have a different set of icons for each component. The iconwell configuration elements are described below: ... 1 2component_or_action_id 3path_to_icon 4string_or_nlsid_element 5string_or_nlsid_element 6<normalbgimage>path_to_background_image 7path_to_disabled_background_image 8<selectedbgimage>path_to_selected_background_image 9path_to_highlighted_background_image 10<defaultid>component_or_action_id

The locator and locatorcontainer classes, Locator and LocatorContainer respectively, add a configuration value that can be read by locator components. Add the element and set the value to true to display the component name instead of the repository name as the breadcrumb in a locator. 1 Contains configuration for the component icons 2 ID of an action or component that will be launched by the icon. This value must match the value of the action or component ID in its XML definition.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

209

image

3 Path within a theme directory to the icon. For example, a path of /icons/perspective/inbox32.gif would map to a file at /root_directory/custom/theme/mytheme/icons/perspective\inbox32.gif. See Web Development Kit Development Guidefor information on how themes are located. 4 Specifies a string value or element whose key represents a label for the icon 5 Specifies a string value or element whose key represents a tooltip for the icon 6 Path within a theme directory to the image that supplies the background for icons in the normal (unselected and enabled) state 7 Path within a theme directory to the image that supplies the background for icons in the disabled state (action not valid for user or context) 8 Path within a theme directory to the image that supplies the background for icons in the selected state 9 Path within a theme directory to the image that supplies the background for icons in the highlighted state (mouseover) 10 ID of an action or component that will initially selected when the iconwell is rendered (default action or component)

image Purpose Generates an HTML image tag ().

Attributes alttext

(Optional) Alternate text to be displayed as a tooltip and when the image fails to load.

border

(Optional) Border (in pixels) around the image, if it is a link. Default is 0 (zero) pixels (that is, no border).

datafield

(Optional) Overrides the value of src attribute with a URL from a data source.

height

(Optional) Height of the image control.

hspace

(Optional) Horizontal margin (white space padding to the left and right) around the image.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

210

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

image

label

(Optional) Overrides the alttext and nlsid attribute values.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the alttext attribute value.

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true). When onclick is used, the image is turned into a link.

runatclient

(Optional) Specifies that the onclick event is to run on the client (True) or the server (False).

src

(Optional) URL to the image on the server. Can be a path on the server or in the repository, for example: src="/webtop/component/getcontent? objectId=0900303980005172" The repository icon may affect performance.

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

211

option

vspace

(Optional) Vertical margin (white space padding to the top and bottom) around the image.

width

(Optional) Width of the image control.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

option Purpose Contains a single static name/value pair entry. Use this tag inside a dropdownlist, listbox, datadropdownlist, or datalistbox control. The name attribute is required. The value can be set on the tag, or it can be passed in from a result set.

Attributes datafield

(Optional) Overrides value with data from a data source.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Text to display to the user in the drop down list or list box.

labeldatafield

(Optional) Overrides label with data from a data source.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

212

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

radio

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the label attribute value.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) Value that is displayed in a drop down list or list box.

visible

(Optional) (Boolean) Whether this control is displayed (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

radio Purpose Generates an HTML radio element.

Attributes cssclass

(Optional) Sets the CSS class that is applied to this control.

datafield

(Optional) Overrides value with data from a data source

enabled

(Optional) Whether this control is enabled (True) or disabled (False).

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

213

radio

group

(Required) Group of radio buttons of which the radio button is a member. Only one radio button in the group can be selected at any one time.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

label

(Optional) Label text for the radio button.

labelalign

(Optional) Alignment of the radio button label. Uses HTML text alignment attributes.

name

(Optional) Name of this control. Named controls are cached on the server. Controls with the same name are automatically indexed.

nlsid

(Optional) NLS lookup key. The string corresponding to the NLS ID is substituted for the value attribute value.

onchange

(Optional) Event fired when this control’s value is changed by the user. This event is not handled immediately. It is handled on the server only when the form is submitted. The onchange event handler cannot run on the client (that is, the runatclient attribute cannot be true).

onclick

(Optional) Event fired when the user clicks this control. This event is handled immediately on the server (when the runatclient attribute is false) or on the client (when the runatclient attribute is true).

runatclient

(Optional) Whether the onclick event is to run on the client (True) or the server (False).

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

214

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

radio

tabindex

(Optional) Value (a whole number from 0 to 32767, inclusive) that determines the order in which this control is tabbed to (that is, receives focus when the user presses the Tab key) in relation to the other controls on the page. Controls on the same JSP are tabbed to in this sequence: Controls that specify a positive number in this attribute are tabbed to starting from the lowest number to the highest. Controls that do not have this attribute, or specify a value of 0 (zero) or no value for this attribute are tabbed to in the order they appear in the character stream. To prevent this control from being tabbed to (in most browsers), specify a value of -1 for this attribute.Since 6.0.

tooltip

(Optional) String displayed when you place the mouse pointer over this control.

tooltipnlsid

(Optional) NLS key to use when looking up a localized tooltip string.

value

(Optional) Whether the radio element is displayed as selected (True) or deselected (False).

visible

(Optional) (Boolean) Whether this control is rendered as visible (True) or hidden (False).

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

Usage The user can select only one radio widget in the group. To check which radio has been selected by the user in your component class, check the state of each radio, similar to the following: if (((Radio)getControl("ctrl1", Radio.class)).getValue()) { // do something for ctrl1 } else if (((Radio)getControl("ctrl2", Radio.class)).getValue()) {

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

215

span

// do something for ctrl2 }

span Purpose Generates HTML <span> open and close tags.

Attributes cssclass

(Optional) CSS class to apply to this control.

datafld

(Optional) HTML datafld attribute.

dataformatas

(Optional) HTML dataformatas attribute.

datasrc

(Optional) HTML datasrc attribute.

dir

(Optional) HTML dir attribute.

id

(Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lang

(Optional) HTML lang attribute.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

title

(Optional) HTML title attribute.

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

216

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

table

table Purpose Generates HTML open and close tags.

Attributes align

(Optional) HTML align attribute.

bgcolor

(Optional) HTML bgcolor attribute.

border

(Optional) HTML border attribute.

cellpadding

(Optional) HTML cellpadding attribute.

cellspacing

(Optional) HTML cellspacing attribute.

cssclass

(Optional) CSS class that is applied to this control.

datapagesize

(Optional) HTML dir attribute.

dir

(Optional) HTML dir attribute.

frame

(Optional) HTML frame attribute.

id

(Optional) ID for this control. The ID is generated by the framework. You can also set the ID in the JSP page.

lang

(Optional) HTML lang attribute.

rules

(Optional) HTML rules attribute.

style

(Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}"

summary

(Optional) HTML summary attribute.

title

(Optional) HTML title attribute.

width

(Optional) HTML width attribute.

EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide

217

td

Description Since 5.x

Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld)

td Purpose Generates HTML

(table cell) open and close tags. Attributes abbr (Optional) HTML abbr attribute. align (Optional) HTML align attribute. axis (Optional) HTML axis attribute. bgcolor (Optional) HTML bgcolor attribute. char (Optional) HTML char attribute. charoff (Optional) HTML charoff attribute. colspan (Optional) HTML colspan attribute. cssclass (Optional) CSS class to apply to this control. dir (Optional) HTML dir attribute. headers (Optional) HTML headers attribute. height (Optional) HTML height attribute. id (Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page. lang (Optional) HTML lang attribute. nowrap (Optional) HTML nowrap attribute. rowspan (Optional) HTML rowspan attribute. 218 EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide th scope (Optional) HTML scope attribute. style (Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" title (Optional) HTML title attribute. valign (Optional) HTML valign attribute. width (Optional) HTML width attribute. Description Since 5.x Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) th Purpose Generates HTML

(table head) open and close tags. Attributes abbr (Optional) HTML abbr attribute. align (Optional) HTML align attribute. axis (Optional) HTML axis attribute. bgcolor (Optional) HTML bgcolor attribute. char (Optional) HTML char attribute. charoff (Optional) HTML charoff attribute. colspan (Optional) HTML colspan attribute. EMC Documentum Web Development Kit and Webtop Version 6 Reference Guide 219 title cssclass (Optional) CSS class to apply to this control. dir (Optional) HTML dir attribute. headers (Optional) HTML headers attribute. height (Optional) HTML height attribute. id (Optional) ID of this control. The ID is generated by the framework. You can also set the ID in the JSP page. lang (Optional) HTML lang attribute. nowrap (Optional) HTML nowrap attribute. rowspan (Optional) HTML rowspan attribute. scope (Optional) HTML scope attribute. style (Optional) CSS rule (enclosed in quotation marks) to apply to this control; for example:style="{COLOR: darkmagenta; TEXT-DECORATION: underline}" title (Optional) HTML title attribute. valign (Optional) HTML valign attribute. width (Optional) HTML width attribute. Description Since 5.x Tag library descriptor dmf (WEB-INF\tlds\dmform_1_0.tld) title Purpose Generates HTML