Text Builder Input - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Text Builder Input

The Text builder takes the inputs described in this table.

Table 1. Text Builder Input
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location Use the Page Location input to specify the page or pages on which this builder call will act.
Text Enter some text that will be displayed at the location(s) described by the page location syntax. You can use the reference chooser to display the results of a service call or method, or the contents of a variable.
Example:
${Variables/currentUser}

Alternatively you can enter Java code, the result of which will be displayed.
Example:
${Java/webAppAccess.getModelName()}

Lookup Table Used Select a lookup table in the model, to be used for translation.
Use this input if you want to translate a text input through a lookup table. For example, you might identify a value in a lookup table and display the label associated with that value as text.
The value to be translated is identified in the Text input above.
Text Format It is possible for the specified text to contain HTML formatting tags. For example, Customer Name. If the Text value is from a variable or other indirect source, you may not know if the text includes formatting tags or not.
You can strip any formatting tags from the text value by setting the Text Format value to: Display tags as written.
If you want to keep any formatting tags, set the Text Format value to: Allow HTML formatting of text.
Replace Tag Contents Enable this checkbox to replace any existing contents in the selected element. If this is true, the builder removes all elements in its target element before adding the text.
When this box is not enabled, the specified text is added as a new child of the element being modified.
For example, if acting on the following element:
The value is: 

selecting Replace Contents would yield:
BUILDER TEXT

while omitting it would generate
The value is: BUILDER TEXT

Advanced

Handle Target Element You can specify how the Text builder call behaves with regard to the named tag on which it operates:

Add

Leaves the tag in place and inserts the text as the tag's value. For example:
 Inserted Text 

Replace

Removes the named tag from the page, inserting the text in its place. For example:
 Inserted Text

Parent topic: Text builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location	Use the Page Location input to specify the page or pages on which this builder call will act.
Text	Enter some text that will be displayed at the location(s) described by the page location syntax. You can use the reference chooser to display the results of a service call or method, or the contents of a variable. Example: ${Variables/currentUser} Alternatively you can enter Java code, the result of which will be displayed. Example: ${Java/webAppAccess.getModelName()}
Lookup Table Used	Select a lookup table in the model, to be used for translation. Use this input if you want to translate a text input through a lookup table. For example, you might identify a value in a lookup table and display the label associated with that value as text. The value to be translated is identified in the Text input above.
Text Format	It is possible for the specified text to contain HTML formatting tags. For example, <b>Customer Name</b>. If the Text value is from a variable or other indirect source, you may not know if the text includes formatting tags or not. You can strip any formatting tags from the text value by setting the Text Format value to: Display tags as written. If you want to keep any formatting tags, set the Text Format value to: Allow HTML formatting of text.
Replace Tag Contents	Enable this checkbox to replace any existing contents in the selected element. If this is true, the builder removes all elements in its target element before adding the text. When this box is not enabled, the specified text is added as a new child of the element being modified. For example, if acting on the following element: <span name="textTarget">The value is: </span> selecting Replace Contents would yield: <span name="textTarget">BUILDER TEXT</span> while omitting it would generate <span name="textTarget">The value is: BUILDER TEXT</span>
Advanced
Handle Target Element	You can specify how the Text builder call behaves with regard to the named tag on which it operates: Add Leaves the tag in place and inserts the text as the tag's value. For example: <span name="TextContainer"> Inserted Text </span> Replace Removes the named tag from the page, inserting the text in its place. For example: <!-- tag appeared below this line --> Inserted Text