Dynamic Table Column builder inputs - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Dynamic Table Column builder inputs

This topic describes the inputs for the Dynamic Table Column builder.

General inputs
Look and feel
Advanced header / data

General inputs

Table 1. General inputs
Input name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Table Name Select the table to which you want to add a column definition.
Column Element Select the name of the column to which you want to assign this builder. Any formatting options appear only in the column you selected in the Column Element drop-down menu.
Where the column appears in the table depends upon the order entered in the Column Elements field in the builder editor of the Dynamic Table builder. For example, assume you entered company, employee, phone number in the Column Elements field in the builder editor of the Dynamic Table builder. This means the company column appears first, the employee column second, and the phone number column third. Important: Ensure that only one Dynamic Table Column builder is assigned to a column.
Header Cell Type Select one of the following object types to appear in the header cell:

Text

Displays the contents as text.

Link

Displays the contents as a link.

Button

Displays the contents as a button label.

Image

Displays the contents as an image.

Image Button

Displays the contents as an image for a button.

Header Text Enter the text to appear in the header. You can also enter an indirect value.
If you leave this field empty, no header appears for the column.
Header Action Type Defines the behavior of the action. Choose an action type based on the action that processes the onClick event and processes any form inputs as part of that action.

Submit form and invoke action

Choose this option if the specified action is a method in the model or LJO and that method processes the inputs to the form on which the button resides.

Submit form to URL

Choose this option if the specified action is a URL outside of the IBM® WebSphere Portlet Factory context that processes the inputs to a form. The specified URL receives the form input values as name and value pairs appended to the URL.

Link to an action

Choose this option if the specified action is a method in the model or LJO (including service calls). Acts as a simple link, transferring control directly to the specified URL. The specified action cannot process any form inputs.

Link to a URL

Choose this option to navigate to a URL outside the WebSphere Portlet Factory context. The URL cannot process any form inputs.

Header Action Appears when the Link, Button, or Image Button option is selected in the Header Cell Type drop-down menu.
Select an action to occur when the link or button in the header is clicked.
Data Cell Type Select one of the following object types to place in the cells of the column:

Text

Displays the contents as text.

Link

Displays the contents as a link.

Button

Displays the contents as a button label.

Image

Displays the contents as an image.

Image Button

Displays the contents as an image for a button.

Data Action Type Defines the behavior of the action. Choose an action type based on the action that processes the onClick event and whether you want to process any form inputs as part of that action.

Submit form and invoke action

Choose this option if the specified action is a method in the model or LJO and that method processes the inputs to the form on which the button resides.

Submit form to URL

Choose this option if the specified action is a URL outside of the IBM WebSphere Portlet Factory context that processes the inputs to a form. The specified URL receives the form input values as name and value pairs appended to the URL.

Link to an action

Choose this option if the specified action is a method in the model or LJO (including service calls). Acts as a simple link, transferring control directly to the specified URL. The specified action cannot process any form inputs.

Link to a URL

Choose this option to navigate to a URL outside the WebSphere Portlet Factory context. The URL cannot process any form inputs.

Data Action Appears when one of the following is selected in the Data Cell Type menu: Link, Button, Image Button.
Select an action to occur when the link, button, or image button is clicked in the column.
(optional) Column Visibility To have the column appear to some users but not to others, assign a visibility setter value to the column. The value entered in this field is to an indirect reference, containing the visibility setter value. This value could change at run time, and as a result, you could define which users can see the column based on their profile.
For example, assume you have a table that contains four columns and some of the columns are to appear only to certain users, do one of the following:

To have only one column not appear to some users, select false; otherwise, assign it the value of true.
To have more than one column not to appear to some users, enter a path to a variable that contains the values for all of the columns, ${Variables/tablecolumns}. The variable of XMLData would resemble the following:
<visibility> <columntagname1>true</columntagname1> <columntagname2>false</columntagname2> <columntagname3>false</columntagname3> <columntagname4>true</columntagname4> </visibility>
where

columntagname1, columntagname2, columntagname3, and columntagname4 correspond to the Column Element for the respective column.
columntagname1 and columntagname4 appear to the user.
columntagname2 and columntagname3 do not appear to the user.

Look and feel

Table 2. Look and feel inputs
Input name Description
(optional) Horizontal Alignment Select one of the following to determine the horizontal alignment of the objects in the column:

left
center
right

(optional) Vertical Alignment Select one of the following to determine the vertical alignment of the objects in the column:

left
center
right

(optional) CSS Style Class If the page links to a cascading stylesheet (CSS) or uses styles embedded in a <STYLE /> element, enter the CSS class name to be used for all data elements in the column.

Advanced header / data

Note: Header inputs are displayed if you select a value for the Header Cell Type input.
Data inputs are displayed if you select a value for the Data Cell Type input.

Table 3. Advanced header / data inputs
Input name Description
Target The window or frame which displays the results of the action. If you do not set this value, the current window or frame is the target. Valid entries include the following:

_self

Display results in the frame containing the form. If the Target setting is not specified, _self is the default.

_blank

Display results in a new browser window.

_parent

Display results in the frameset above the frame containing the form.

_top

Display results in the topmost frameset.

name

You can also specify the name of a frame in the current frameset.

Note: All these targets are relative to the form being processed, not the button itself.
Rendering Mode If the specified action returns a specific page, set Rendering Mode to Normal.
If you do not know the specific page that gets returned, set Rendering Mode to Return Outermost page after running action. For example, use this setting when creating a builder.

Parent topic: Dynamic Table Column 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.
Table Name	Select the table to which you want to add a column definition.
Column Element	Select the name of the column to which you want to assign this builder. Any formatting options appear only in the column you selected in the Column Element drop-down menu. Where the column appears in the table depends upon the order entered in the Column Elements field in the builder editor of the Dynamic Table builder. For example, assume you entered company, employee, phone number in the Column Elements field in the builder editor of the Dynamic Table builder. This means the company column appears first, the employee column second, and the phone number column third. Important: Ensure that only one Dynamic Table Column builder is assigned to a column.
Header Cell Type	Select one of the following object types to appear in the header cell: Text Displays the contents as text. Link Displays the contents as a link. Button Displays the contents as a button label. Image Displays the contents as an image. Image Button Displays the contents as an image for a button.
Header Text	Enter the text to appear in the header. You can also enter an indirect value. If you leave this field empty, no header appears for the column.
Header Action Type	Defines the behavior of the action. Choose an action type based on the action that processes the onClick event and processes any form inputs as part of that action. Submit form and invoke action Choose this option if the specified action is a method in the model or LJO and that method processes the inputs to the form on which the button resides. Submit form to URL Choose this option if the specified action is a URL outside of the IBM® WebSphere Portlet Factory context that processes the inputs to a form. The specified URL receives the form input values as name and value pairs appended to the URL. Link to an action Choose this option if the specified action is a method in the model or LJO (including service calls). Acts as a simple link, transferring control directly to the specified URL. The specified action cannot process any form inputs. Link to a URL Choose this option to navigate to a URL outside the WebSphere Portlet Factory context. The URL cannot process any form inputs.
Header Action	Appears when the Link, Button, or Image Button option is selected in the Header Cell Type drop-down menu. Select an action to occur when the link or button in the header is clicked.
Data Cell Type	Select one of the following object types to place in the cells of the column: Text Displays the contents as text. Link Displays the contents as a link. Button Displays the contents as a button label. Image Displays the contents as an image. Image Button Displays the contents as an image for a button.
Data Action Type	Defines the behavior of the action. Choose an action type based on the action that processes the onClick event and whether you want to process any form inputs as part of that action. Submit form and invoke action Choose this option if the specified action is a method in the model or LJO and that method processes the inputs to the form on which the button resides. Submit form to URL Choose this option if the specified action is a URL outside of the IBM WebSphere Portlet Factory context that processes the inputs to a form. The specified URL receives the form input values as name and value pairs appended to the URL. Link to an action Choose this option if the specified action is a method in the model or LJO (including service calls). Acts as a simple link, transferring control directly to the specified URL. The specified action cannot process any form inputs. Link to a URL Choose this option to navigate to a URL outside the WebSphere Portlet Factory context. The URL cannot process any form inputs.
Data Action	Appears when one of the following is selected in the Data Cell Type menu: Link, Button, Image Button. Select an action to occur when the link, button, or image button is clicked in the column.
(optional) Column Visibility	To have the column appear to some users but not to others, assign a visibility setter value to the column. The value entered in this field is to an indirect reference, containing the visibility setter value. This value could change at run time, and as a result, you could define which users can see the column based on their profile. For example, assume you have a table that contains four columns and some of the columns are to appear only to certain users, do one of the following: To have only one column not appear to some users, select false; otherwise, assign it the value of true. To have more than one column not to appear to some users, enter a path to a variable that contains the values for all of the columns, ${Variables/tablecolumns}. The variable of XMLData would resemble the following: <visibility> <columntagname1>true</columntagname1> <columntagname2>false</columntagname2> <columntagname3>false</columntagname3> <columntagname4>true</columntagname4> </visibility> where columntagname1, columntagname2, columntagname3, and columntagname4 correspond to the Column Element for the respective column. columntagname1 and columntagname4 appear to the user. columntagname2 and columntagname3 do not appear to the user.

Input name	Description
(optional) Horizontal Alignment	Select one of the following to determine the horizontal alignment of the objects in the column: left center right
(optional) Vertical Alignment	Select one of the following to determine the vertical alignment of the objects in the column: left center right
(optional) CSS Style Class	If the page links to a cascading stylesheet (CSS) or uses styles embedded in a <STYLE /> element, enter the CSS class name to be used for all data elements in the column.

Input name	Description
Target	The window or frame which displays the results of the action. If you do not set this value, the current window or frame is the target. Valid entries include the following: _self Display results in the frame containing the form. If the Target setting is not specified, _self is the default. _blank Display results in a new browser window. _parent Display results in the frameset above the frame containing the form. _top Display results in the topmost frameset. name You can also specify the name of a frame in the current frameset. Note: All these targets are relative to the form being processed, not the button itself.
Rendering Mode	If the specified action returns a specific page, set Rendering Mode to Normal. If you do not know the specific page that gets returned, set Rendering Mode to Return Outermost page after running action. For example, use this setting when creating a builder.