An input definition is a structure in the builder definition that describes the input for a builder.
For example, you can describe the input in terms of its type, editor widget (for example, text input and select box), or the input group to which it belongs. The input definitions you create only need to specify values for the elements not defined by a base builder definition or those elements that you want to override.
Table 1. Elements that you can use to define an input to a builder
|Input definition element ||Description |
|<Prompt />||The user-readable description for this input. The Builder Call Editor displays this value to the left of the input editor widget. |
|<HelpText />||The text that appears as a tool tip when the user hovers over the input in the builder call editor. |
|<ProfileType />||The type of value set when the user profiles the input. Possible values for the ProfileType are: |
The input value cannot be profiled.Value
The entire input value can be profiled.XmlElements
Individual string values within the XML can be profiled. Valid for XML type input only.
|<Callable />||Determines whether accessor methods should be generated for this input in the callable version of this builder. Possible values are true or false.|
|<Editor />||Determines the input widget displayed in the builder call editor that allows the user to specify a value to this input. If you are extending a base input definition, the editor is already specified by the base definition.|
|<Visible />||Determines whether the builder call editor displays the input widget for this input by default. You can set the Visible value for one or more input definitions as false, and use a coordinator to set the Visible value for those inputs to true, based on some condition.|Inheriting input and coordinator behavior
An input definition can inherit from any other input definition in the system, by setting the base attribute of the InputDefinition
to the builder ID followed by the input name.
Suppressing the display of an input
You can designate an input definition to be hidden from the builder call editor by adding (or setting) the input definition <Visible />
value to false
Parent topic: Overview of builder architecture