IconButton DTD and XML definitions

The IconButton has many of the same attributes as the TaskLauncherButton, but also contains an iconName attribute corresponding to the icon to display on the button. It has the following entry in the DTD file:
Table 1. IconButton definition
Line entry in the DTD file Description
<!ELEMENT IconButton EMPTY> An IconButton does not contain any sub-elements
<!ATTLIST IconButton
    name CDATA #IMPLIED
    iconName CDATA #REQUIRED
    toolTipText CDATA #REQUIRED
    width CDATA "32"
    height CDATA "22"
    x CDATA #REQUIRED
    y CDATA #REQUIRED
    operation CDATA #IMPLIED
    process CDATA #IMPLIED
    application CDATA #IMPLIED
    operationPanel CDATA #IMPLIED
    code CDATA #IMPLIED
    parameters CDATA #IMPLIED
    shortDescription CDATA #IMPLIED
    longDescription CDATA #IMPLIED
    executeOperation CDATA #IMPLIED
    taskName CDATA #REQUIRED
    enabled (true|false) #IMPLIED
    errorMessageOnInstantiateOperation CDATA "OperationerrorMessage"
    onClick CDATA #IMPLIED
    onMouseEntered CDATA #IMPLIED
    onMouseExited CDATA #IMPLIED
    onInitialize CDATA #IMPLIED>
Attribute list
Table 2. IconButton attributes
Attribute Description
name Name used by the Desktop to identify this component. Applications can have access to this object at runtime by requesting it by name from the Desktop.
iconName Name of the file containing an icon to be set into the button (mandatory)
toolTipText Text that is shown when the mouse cursor is moved over the button (mandatory)
width Width of the button
height Height of the button
x Horizontal coordinate for the location of the button (mandatory)
y Vertical coordinate for the location of the button (mandatory)
operation Name of the operation that launches when the button is clicked. This name must match an operation name in any of the operation files handled by the toolkit. The operation is instantiated using the standard toolkit mechanism (DSEOperation.readObject(operation)).
process Name of the process to be instantiated by the Navigation Controller when the button is clicked
application Name of the application that launches when the button is clicked. The name must include the name of the package where the Java class is defined.
operationPanel Identifier (id) of the operation panel defined in the view definition file (view.xml) that is associated with the panel. If instantiation using the definition file fails, then the panel will be instantiated using this value directly as the classname for instantiation.
code Code by which the task will be identified by the system. Applications or operation can request a task with a specific code from the Desktop.
parameters String representing the list of parameters accepted by the operation. Any operation that accepts parameters must define a format named fastPathInputFormat that describes the format that the string should have. If the parameters attribute is specified, its value will be unformatted in the process context before launching the task.
shortDescription Text that is shown as the label of the launched task in the TaskArea
longDescription Text that is shown when the mouse cursor is moved over the launched task in the TaskArea
executeOperation Whether the operation executes before displaying the operation panel
taskName Name of the task to launch (mandatory)
enabled Whether the button is enabled when it is created
errorMessageOn InstantiateOperation Text that is shown if an error occurs when launching the task
onClick Java code to be executed when the button is clicked
onMouseEntered Java code to be executed when the mouse cursor is placed over the button
onMouseExited Java code to be executed when the mouse cursor is moved away from the button
onInitialize Java code to be executed when the component is initialized
The following is an example of an XML definition for an IconButton:
<IconButton x="51" y="56" iconName="/risks.gif" 
    taskName="TX01" operation="riskInfo" 
    operationPanel="RiskInfoView" 
    shortDescription="Risks Information"
    longDescription="Customer risks profile"
    toolTipText="Risks" />