Portlet Customizer builder inputs - Portlet Factory v6.1.2

Portlet Customizer builder inputs

+
Search Tips | Advanced Search

General inputs
Tab Appearance
Display Options
Label Translation Settings
Advanced

General inputs

Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Portlet Enter the name of the model for which this model is the configure or edit model. In the Portlet Adapter builder in this model, make sure that the Custom Configure or Custom Edit Model input names this model as its value.
Profile sets applied to the model are listed in the Profile Sets input.
Profile Sets Determines how profile sets and profile entries get exposed in the edit or configure mode of the portlet. Choose:

Profiles

Allows the user to specify a profile to apply to the portlet. Use this setting to allow the user to apply all the values determined by the selected profile to the portlet. For example, a profile set could contain profiles oriented towards the user's region. Using this setting on such a profile set allows the user to determine the regional profile to use, while the developer retains control over the individual values in that profile.

Input Prefix

Allows models to use a prefix instead of the traditional naming convention of profileSetName_entryname which can become lengthy. This prefix allows you to create shorter variable names.
Note: Changing prefixes in existing models can cause issues if other builders (such as Data Page builder) rely on the variable names created by the Portlet Customizer builder. This feature is recommended when creating new models. A naming clash can occur depending on two or more profile sets if you have the same named entry names and use the same name prefixes.

Handling

Allows the user to specify values, or a profile, for each entry in the profile set when customizing the portlet. Use this setting to allow the user to set portlet parameters. For example, a stock-symbol list, zip-code for weather, or background color. All entries in the profile associated with the request are exposed.

Update Profile Sets for Portlet Click this button to update the list of profile sets.
You typically do this if you change the profile sets that a portlet model is associated with. You would continue to use the existing Update from Profile Set button if just the contents of the profile had changed and not the profile set name.
Number of Pages Determines how many pages this builder creates for the customizer user interface (UI).
Use Tabbed Pages Enable this input to use tabbed pages in place of page navigation buttons.
Note: When this input is enabled, fill in the inputs in the Tab Appearance section of the builder call editor.
Input Values Determine the page number on which this input value appears in the customizer and specify the prompt and default value for the input field in the form.
Treat Text as XML Enable this input to force the Portlet Customizer builder to treat any profile value text that appears to be XML (begins with <, and ends with >), as XML.
Setting this input enables the Data Page builder to operate on the profile data in a more meaningful way.
For example the XML text might be repeating data that the Data Page builder can treat as a table. If this input is not checked, the profile value is treated as text, which happens to look like XML.
Update Input Values from Profile Set Click this button to update the contents of an individual profile set.
You typically do this if contents of the profile have changed and the profile set name has not changed.

Tab Appearance

Input Name Description
Control Type Select the radio button that represents the tab style you require. You can choose:

Text

To make entire tab cell active and clickable. Tab label is a simple text label.

Link

To make tab label a link. Only link text is active and clickable.

Image

To make tab an image button. Entire image is active and clickable.

Note: Each Control Type input has additional inputs for specifying the appearance (see below).
Orientation Choose the tab orientation you require. You can choose:

Horizontal

To locate tabs across the top of a page.

Vertical

To locate tabs down the side of a page.

Style for background of tabs This input applies to text and link style tabs.
Select a style to be used for the background of individual tabs in the tab control.
Note: If you specify a Selected Tab variable, this style is not applied to the selected tab.
Style for background of selected tabs This input applies to text and link style tabs.
If you specify a Selected Tab variable, select a style that is applied to the selected tab.
Style for text of tabs This input applies to text and link style tabs.
Select a style that is used for the label of individual cells in the tab control.
Note: If you specified a Selected Tab variable, this style is not applied to the selected tab.
Style for text of selected tabs This input applies to text and link style tabs.
If you specified a Selected Tab variable, select a style that is applied to the selected tab text label.
Alt text element This input applies to image style tabs.
Select the name of the element that specifies the alternate text for each tab. This may be the same as the ID element specified above.
Prefix for image name This input applies to image style tabs.
Select a prefix used to construct the image name for each tab in the tab control.
Image filenames are constructed by concatenating the prefix, the tab ID, and the image suffix to build a unique image name for each tab.
For example, consider the following code snippet of typical data:
<tabs> <tab> <id>editPage1</id> <label>List</label> </tab> <tab> <id>editPage2</id> <label>Details</label> </tab> </tabs>

For this set of images:

editPage1.gif
editPage2.gif

The image prefix is editPage1, editPage2, as specified by the <id> element. The <label> tags contain text that appears on each tab.
Suffix for image name This input applies to image style tabs.
Select a suffix used to construct the image name for each tab in the tab control.
If you specified a Selected tab variable, this suffix is used to construct the image name for unselected tabs.
Suffix for selected image name This input applies to image style tabs.
Select a suffix for selected image name.
If you specified a Selected Tab variable, this suffix is used to construct a selected image name.
If the selected images are:

editPage1_Selected.gif
editPage2_Selected.gif

The suffix for selected images is _Selected.gif.
Suffix for hover image name This input applies to image style tabs.
Select a suffix for hover image name.
The suffix is used to construct a hover image for each tab in the tab control. This image is displayed when the user places the cursor over a tab.
If the set of hover images is:

editPage1_Hover.gif
editPage2_Hover.gif

The suffix for selected images is _Hover.gif.
Custom HTML Base Page Specify the URL of a custom base page to use as the base HTML of the tab control. The HTML should contain control suitable for repeating with a Repeated Region builder.
This builder relies on three specific tag names that must be in your HTML:

TabItemRepeat

Defines the region that is repeated.

TabItemCell

Defines the region that is the background for Text and Link style tabs. For Text style builders, an onclick HTML Event Action is placed on this tag.

TabItemText

Defines the tab label. A Text, Link, or Image Button control is placed on this tag.

See the default base pages at the location below for examples of appropriate HTML:

servableContent/factory/pages/tabBuilder_horizontal.html
servableContent/factory/pages/tabBuilder_vertical.html

Tab Labels Use this input to set the label text for each page tab.
Choose a page and assign a tab label to it.
Note: If you specify a Localized Resource below, this builder looks in the specified resource for the text (key) entered in the Tab Labels input table. If a localized version of the text exists in the resource variable, the builder uses it as the tab label. If localized text is not available, the builder uses plain text.

Display Options

Table 3. Display Options inputs
Input Name Description
Page Import Determine the page or pages to be imported for this customizer. You can choose to import:

Single Page

Same HTML page is used for all pages in the customizer.

Multiple Pages

Unique HTML pages can be used for each page of the customizer.

Page URL(s) Enter the path (relative to WebSphere Portlet Factory servable root directory) to the HTML page on which the Portlet Customizer builder adds a form for setting the profile values. You can create your own HTML page to alter or enhance the default display of the form.
Note: If you elect to import multiple HTML pages, a table is displayed in which you can associate a specific imported HTML page with a page in the Portlet Customizer builder.
Default Page URL Enter the path (relative to WebSphere Portlet Factory servable root directory) to the HTML page on which the Portlet Customizer builder adds a form for setting the profile values. You can create your own HTML page to alter or enhance the default display of the form.
Make URLs Absolute Recommended and enabled by default. Enable this input to prompt WebSphere Portlet Factory to generate absolute URLs to the HTML resources (images or style sheets, for example) that the page specified in the Page URL input use.
Stylesheet URL Enter the path (relative to WebSphere Portlet Factory servable root directory) to a CSS stylesheet to use for formatting the HTML display.
HTML Template File Select an HTML Page Automation template file that is used to generate the Customizer HTML pages.

Label Translation Settings

Table 4. Label Translation Settings input
Input Name Description
Localized Resource Use this input to specify an existing Localized Resource builder in the model to use with this builder.

Advanced

Table 5. Advanced inputs
Input Name Description
Post-Save Method Use this input to specify a method to invoke after the page input data has been saved to their corresponding variables.
You typically invoke such a method to manually process the customizer values before updating the data store.
Post-Save Method Behavior Use this input to determine if the Post-Save Method is called when validation errors occur. You can choose:

Always call Post-Save method

To perform Post-Save operation regardless of validation error status.

Call Post-Save Method only if all fields were valid

To block Post-Save when validation errors occur.

Generate Main By default, the Portlet Customizer builder adds a main Action List builder to the model. This Action List builder displays editPage1.
To implement your own main action, disable this input. Be sure to call the editPage1 action, which displays the customization form generated by the Portlet Customizer builder call.
Remain in Customizer on error Use this input to control portlet edit and config behavior.

Enable

To include, in the generated Update method, code to check for data page errors (such as missing required inputs). If the errors occur, a request property named bowstreet.remainInCustomizer (defined on com.bowstreet.adapters.Constants) is set to true, and the current page is specified to be re-displayed.

Setting the bowstreet.remainInCustomizer request property to true causes the Portlet Adapter builder to skip the actual saving of the profile data, and remain in the edit and config mode.
Add Clear Data Button Enable this input to add a button to the page to clear the profile information for the internal edit and configure storage. This feature is useful during development and testing, or when switching between edit and configure modes.
Clearing the portlet data causes the model to regenerate using the defaults from the profile set.

Parent topic: Portlet Customizer 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.
Portlet	Enter the name of the model for which this model is the configure or edit model. In the Portlet Adapter builder in this model, make sure that the Custom Configure or Custom Edit Model input names this model as its value. Profile sets applied to the model are listed in the Profile Sets input.
Profile Sets	Determines how profile sets and profile entries get exposed in the edit or configure mode of the portlet. Choose: Profiles Allows the user to specify a profile to apply to the portlet. Use this setting to allow the user to apply all the values determined by the selected profile to the portlet. For example, a profile set could contain profiles oriented towards the user's region. Using this setting on such a profile set allows the user to determine the regional profile to use, while the developer retains control over the individual values in that profile. Input Prefix Allows models to use a prefix instead of the traditional naming convention of profileSetName_entryname which can become lengthy. This prefix allows you to create shorter variable names. Note: Changing prefixes in existing models can cause issues if other builders (such as Data Page builder) rely on the variable names created by the Portlet Customizer builder. This feature is recommended when creating new models. A naming clash can occur depending on two or more profile sets if you have the same named entry names and use the same name prefixes. Handling Allows the user to specify values, or a profile, for each entry in the profile set when customizing the portlet. Use this setting to allow the user to set portlet parameters. For example, a stock-symbol list, zip-code for weather, or background color. All entries in the profile associated with the request are exposed.
Update Profile Sets for Portlet	Click this button to update the list of profile sets. You typically do this if you change the profile sets that a portlet model is associated with. You would continue to use the existing Update from Profile Set button if just the contents of the profile had changed and not the profile set name.
Number of Pages	Determines how many pages this builder creates for the customizer user interface (UI).
Use Tabbed Pages	Enable this input to use tabbed pages in place of page navigation buttons. Note: When this input is enabled, fill in the inputs in the Tab Appearance section of the builder call editor.
Input Values	Determine the page number on which this input value appears in the customizer and specify the prompt and default value for the input field in the form.
Treat Text as XML	Enable this input to force the Portlet Customizer builder to treat any profile value text that appears to be XML (begins with <, and ends with >), as XML. Setting this input enables the Data Page builder to operate on the profile data in a more meaningful way. For example the XML text might be repeating data that the Data Page builder can treat as a table. If this input is not checked, the profile value is treated as text, which happens to look like XML.
Update Input Values from Profile Set	Click this button to update the contents of an individual profile set. You typically do this if contents of the profile have changed and the profile set name has not changed.

Input Name	Description
Control Type	Select the radio button that represents the tab style you require. You can choose: Text To make entire tab cell active and clickable. Tab label is a simple text label. Link To make tab label a link. Only link text is active and clickable. Image To make tab an image button. Entire image is active and clickable. Note: Each Control Type input has additional inputs for specifying the appearance (see below).
Orientation	Choose the tab orientation you require. You can choose: Horizontal To locate tabs across the top of a page. Vertical To locate tabs down the side of a page.
Style for background of tabs	This input applies to text and link style tabs. Select a style to be used for the background of individual tabs in the tab control. Note: If you specify a Selected Tab variable, this style is not applied to the selected tab.
Style for background of selected tabs	This input applies to text and link style tabs. If you specify a Selected Tab variable, select a style that is applied to the selected tab.
Style for text of tabs	This input applies to text and link style tabs. Select a style that is used for the label of individual cells in the tab control. Note: If you specified a Selected Tab variable, this style is not applied to the selected tab.
Style for text of selected tabs	This input applies to text and link style tabs. If you specified a Selected Tab variable, select a style that is applied to the selected tab text label.
Alt text element	This input applies to image style tabs. Select the name of the element that specifies the alternate text for each tab. This may be the same as the ID element specified above.
Prefix for image name	This input applies to image style tabs. Select a prefix used to construct the image name for each tab in the tab control. Image filenames are constructed by concatenating the prefix, the tab ID, and the image suffix to build a unique image name for each tab. For example, consider the following code snippet of typical data: <tabs> <tab> <id>editPage1</id> <label>List</label> </tab> <tab> <id>editPage2</id> <label>Details</label> </tab> </tabs> For this set of images: editPage1.gif editPage2.gif The image prefix is editPage1, editPage2, as specified by the <id> element. The <label> tags contain text that appears on each tab.
Suffix for image name	This input applies to image style tabs. Select a suffix used to construct the image name for each tab in the tab control. If you specified a Selected tab variable, this suffix is used to construct the image name for unselected tabs.
Suffix for selected image name	This input applies to image style tabs. Select a suffix for selected image name. If you specified a Selected Tab variable, this suffix is used to construct a selected image name. If the selected images are: editPage1_Selected.gif editPage2_Selected.gif The suffix for selected images is _Selected.gif.
Suffix for hover image name	This input applies to image style tabs. Select a suffix for hover image name. The suffix is used to construct a hover image for each tab in the tab control. This image is displayed when the user places the cursor over a tab. If the set of hover images is: editPage1_Hover.gif editPage2_Hover.gif The suffix for selected images is _Hover.gif.
Custom HTML Base Page	Specify the URL of a custom base page to use as the base HTML of the tab control. The HTML should contain control suitable for repeating with a Repeated Region builder. This builder relies on three specific tag names that must be in your HTML: TabItemRepeat Defines the region that is repeated. TabItemCell Defines the region that is the background for Text and Link style tabs. For Text style builders, an onclick HTML Event Action is placed on this tag. TabItemText Defines the tab label. A Text, Link, or Image Button control is placed on this tag. See the default base pages at the location below for examples of appropriate HTML: servableContent/factory/pages/tabBuilder_horizontal.html servableContent/factory/pages/tabBuilder_vertical.html
Tab Labels	Use this input to set the label text for each page tab. Choose a page and assign a tab label to it. Note: If you specify a Localized Resource below, this builder looks in the specified resource for the text (key) entered in the Tab Labels input table. If a localized version of the text exists in the resource variable, the builder uses it as the tab label. If localized text is not available, the builder uses plain text.

Input Name	Description
Page Import	Determine the page or pages to be imported for this customizer. You can choose to import: Single Page Same HTML page is used for all pages in the customizer. Multiple Pages Unique HTML pages can be used for each page of the customizer.
Page URL(s)	Enter the path (relative to WebSphere Portlet Factory servable root directory) to the HTML page on which the Portlet Customizer builder adds a form for setting the profile values. You can create your own HTML page to alter or enhance the default display of the form. Note: If you elect to import multiple HTML pages, a table is displayed in which you can associate a specific imported HTML page with a page in the Portlet Customizer builder.
Default Page URL	Enter the path (relative to WebSphere Portlet Factory servable root directory) to the HTML page on which the Portlet Customizer builder adds a form for setting the profile values. You can create your own HTML page to alter or enhance the default display of the form.
Make URLs Absolute	Recommended and enabled by default. Enable this input to prompt WebSphere Portlet Factory to generate absolute URLs to the HTML resources (images or style sheets, for example) that the page specified in the Page URL input use.
Stylesheet URL	Enter the path (relative to WebSphere Portlet Factory servable root directory) to a CSS stylesheet to use for formatting the HTML display.
HTML Template File	Select an HTML Page Automation template file that is used to generate the Customizer HTML pages.

Input Name	Description
Post-Save Method	Use this input to specify a method to invoke after the page input data has been saved to their corresponding variables. You typically invoke such a method to manually process the customizer values before updating the data store.
Post-Save Method Behavior	Use this input to determine if the Post-Save Method is called when validation errors occur. You can choose: Always call Post-Save method To perform Post-Save operation regardless of validation error status. Call Post-Save Method only if all fields were valid To block Post-Save when validation errors occur.
Generate Main	By default, the Portlet Customizer builder adds a main Action List builder to the model. This Action List builder displays editPage1. To implement your own main action, disable this input. Be sure to call the editPage1 action, which displays the customization form generated by the Portlet Customizer builder call.
Remain in Customizer on error	Use this input to control portlet edit and config behavior. Enable To include, in the generated Update method, code to check for data page errors (such as missing required inputs). If the errors occur, a request property named bowstreet.remainInCustomizer (defined on com.bowstreet.adapters.Constants) is set to true, and the current page is specified to be re-displayed. Setting the bowstreet.remainInCustomizer request property to true causes the Portlet Adapter builder to skip the actual saving of the profile data, and remain in the edit and config mode.
Add Clear Data Button	Enable this input to add a button to the page to clear the profile information for the internal edit and configure storage. This feature is useful during development and testing, or when switching between edit and configure modes. Clearing the portlet data causes the model to regenerate using the defaults from the profile set.