|Reset all inputs to defaults ||Click to clear all the builder call editor input fields and restore their default contents. |
You can start creating a new builder with a clean slate.
|Builder Type ||Select the type of builder to create by choosing: |
The basic WebApp builder interface. To implement your desired functionality, edit the generated BuilderNamedoBuilderCall method.Page Control Builder
For builders that put JSP or HTML on a page at a specified location. The page location is passed as an argument to the doBuilderCall method.Model-Based Builder
Used to create a builder from a model. First make a model and profile all the inputs that you want to expose in your new builder.Model-Based Wizard Builder
Creates the code necessary to add a wizard that implements the New Factory Model functionality.
|Model Name ||This input is available when builder type is Model-Based Builder or Model-Based Wizard. |
Specify the name of a model that contains the functionality you want encapsulate into a builder.
|Builder ID ||Specify the unique identifier of the builder. The format of this ID should be that of a fully-qualified Java class name. For example: com.acme.builder.MyCustomBuilder |
|Readable Name ||Specify the user-visible name of the builder. The name you enter here is displayed in the builder picker. |
Note: IBM® WebSphere® Portlet Factory does not support the use of bidirectional characters in builder names. This might cause problems in languages in which these types of characters are commonly used, such as traditional Chinese, simplified Chinese, Korean, and Japanese.
|Description ||Specify a builder description. |
Text that you enter here is displayed at the top of the builder editor page and should describe the builder functionality.
|Builder Class ||Specify the full class name for the builder regen class to be generated.|
Note: This input defaults to the value of the Builder ID input.
|Update Builder Input names from model ||For model-based builders, press this button to incorporate in the builder changes made in the builder underlying model. |
If you add, delete or change an input in the model that represents your builder, you might need to update input names.
|Generate Coordinator ||Enable to generate a coordinator class for implementing dynamic builder call editor behavior. |
For example, you can use this feature to make input values drive the layout of the builder user interface. For example, when a user selects a particular input, additional inputs can be displayed dynamically as required.
|Coordinator Class ||Specify the full class name for the coordinator to be generated, or the existing coordinator to be used. |
|Generate Helper ||Enable to generate a builder helper LJO class. |
This class can be used to implement methods that can be called during execution.
|Helper Class ||Available when Generate Helper is selected. Specify the full class name for the helper LJO class to be generated. For example: com.mycompany.runtime.DataRetrievalHelper |
|Category ||Specify the category, if any, under which you want this builder to appear in the builder picker. |
If no category is specified, an error is generated and the builder is unavailable.
|Help File ||Specify the name and path of the HTML help file for this builder. This file will be displayed when a user presses Help in the builder call editor. |
If no help file is specified, no help is available for the builder.
|Required Version ||Specify the minimum version of WebSphere Portlet Factory Designer required for use with this builder. |
If no required version is specified, all WebSphere Portlet Factory Designer versions will attempt to load and use this builder without warning.
|Generate Builder API ||Enable to generate a builder API class for your builder. |
This allows other builders to programmatically invoke this builder.
The builder can be accessed by model-based builders whether or not an API class is generated, but this class simplifies the development of Java-based builders that may want to invoke this builder.
|Builder Pages ||This input is available when Builder type is Model-Based Wizard. |
Use this input to identify the various pages in the wizard. For each page in your wizard, you can specify the internal identifier, the user-visible name, and a description for the page.
|Builder Inputs ||Use this section to identify the inputs to make available in your builder. Inputs created here are displayed in your builder UI. |
To delete an input you created, right-click on the input name and select Delete Row.
For each input, you can provide some or all of the following information:
A string that identifies the input.Input Type
The type of input widget used to represent the input. For example, you might choose a text box, list table, model picker or indirect reference. The appropriate widget is used based on your choice.Prompt
Text displayed adjacent to the input identifying it.Help Text
Text string displayed when a user hovers over the input with the cursor. Profile Type
Text to describe the type of profile. Is Required
Enable to make input a required value. This forces the user to provide the input.Visible Input
Enable to display this input in the builder editor page. Disable to hide the input. Hide an input if its value is taken from another source, such as a when an underlying input is computed from two or more visible inputs. Inputs may also be hidden initially and then later made visible by the coordinator when the value of some other input changes.Callable Input
If you generate a builder API, enable to make this input public in the builder API. Disable to make the input private and thus unavailable.Extra Data
If the builder input editor presents a list of choices (for example, Combo box or Radio button), then the values to display can be specified here in a comma-separated list. For other input types, this can be left blank.