Builder widgets

 

This list is intended to provide a details on all widget names and arguments provided by the Designer for use by builder authors. Note that it is recommended that builder authors use the input definitions provided in the com.bowstreet.core.Base.bdef and com.bowstreet.core.WebAppBase.bdef. However, in cases where this does not provide the needed functionality, the following widgets can be used directly by the builder authors.

 

Abstract Classes

Note that the arguments defined in these abstract classes will be available to all subclasses.

 

com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Base class for generic builder widgets. All other abstract widget

classes extend this class.

Arguments:

Name	Type	Desc
enabled	true/false (true)	Whether or not the underlying SWT widget is enabled.

com.bowstreet.designer.builders.widgets.AbstractButtonWidget

Description: Abstract base class for button type widgets.

Arguments:

Name	Type	Desc
none

com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Abstract base class for "chooser" type widgets, i.e. a text field with an

attached button which will display a picker allowing the user to choose

an appropriate value.

Arguments:

Name	Type	Desc
append	true/false (false)	If set to true, the value selected in the chooser will be inserted into the text field at the cursor location- if false, any value in the text field will be replaced.

com.bowstreet.designer.builders.widgets.AbstractComboListWidget

Description: Abstract base class for select or combo type widgets which are

populated by the widget class itself (for example, by values from the

WebApp).

Arguments:

Name	Type	Desc
isEditable	true/false (false)	Whether or not the select list can be edited directly by user.

com.bowstreet.designer.builders.widgets.AbstractStyledTextWidget

Description: Abstract base class for text type widgets which have text formatting

capabilities.

Arguments:

Name	Type	Desc
linewrap	true/false (false)	Whether or not line wrapping is enabled for the text widget.

com.bowstreet.designer.builders.widgets.AbstractTextWidget

Description: Abstract base class for text widgets.

Arguments:

Name	Type	Desc
data	String	Initial value for text widget.
filter	**Alphabetic, **AlpahNumeric, **ObjectName (none)	Filter for values entered into text widget.

com.bowstreet.designer.builders.widgets.AbstractUpdateableBuilderWidget

Description: Abstract base class for widgets which will be notified when the open

is generated, and given a chance to update themselves.

Arguments:

Name	Type	Desc
label	String	label for button

 

 

Concrete Widget Classes

com.bowstreet.widget.ActionChooser-

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Displays dialog which allows user to select action from web app, which

is used to populate the text widget.

Arguments:

Name	Type	Desc
showMethodsWithArguments	true/false (false)	Whether or not to show methods with arguments- only applies to ActionList
showSpecialActions	true/false (false)	Whether or not to show "special" actions- return, assignment, etc.
useIndirectReferencePicker	true/false (false)	If true, use the indirect reference chooser.

com.bowstreet.widget.ActionList

extends com.bowstreet.designer.builders.widgets.ListWidget

Description: Extends com.bowstreet.widgets.ListWidget. Displays a list with a

single column. In each row, the user can select an action, thus creating

a list of actions to be performed.

Arguments:

Name	Type	Desc
same as ListWidget
allowAdd	Boolean	Can user add row to end of table (TRUE)
allowReorder	Boolean	Can user reorder table rows (TRUE)
allowDynamicUpdate	Boolean	Allow setting of value without stopping editing in current cell (FALSE)
minColumnSize	Integer	Allow user to specify min col size
CustomChoices		Provides a way for adding arbitrary nodes to a contained tree picker. Example: "Fruits/Pear Fruits/Apple"

com.bowstreet.widget.Button

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Basic button widget.

Arguments:

Name	Type	Desc
label	String	label for button

com.bowstreet.widget.CheckBox

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Basic checkbox widget.

Arguments:

Name	Type	Desc
listData	comma-delimited list (false,true)	List of values to be returned when getData() is called-if more than two, all but first two are ignored.
listDataObject	instance of java.util.Collection (null)	list of values to be returned when getData() is called- if more than two, all but first two are ignored.
selectItem	one of the listData items (false)	initial value of check widget

com.bowstreet.widget.ClassChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Chooser type widget, which allows the user to select a fully qualified

class name. The chooser will be populated with classes contained in

jars in <WebSphere Portlet Factory install path>/WEB-INF/lib (with core factory jars

filtered out), and classes from jars and directories contained in the

directories specified in the WebSphere Portlet Factory property

bowstreet.dynamic.class.load.path.

Arguments:

Name	Type	Desc
allowPackageSelection	true/false (false)	If set to true, allow package selection, and will format the returned value if it is a package (i.e com.bowstreet.*).

com.bowstreet.widget.Combo

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: ComboWidget

Arguments:

Name	Type	Desc
memoryKey	String	If this argument is specified, values which are entered into the combo box will be "remembered", i.e. they will kept in a file and shown in the selection list for any combo box which shares the same memoryKey. If list items are also set via listData/listLabel arguments, the memory values will be concatinated with the argument values.
listData	comma-delimited list	List of values for the combo box selections.
listLabels	comma-delimited list	List of values for the combo box selections.
selectedItem	String	Item which will be presented when the combo box is first displayed
listDataObject	java.util.Collection object	Collection object containing the data for the combo box selections
listLabelObject	java.util.Collection object	Collection object containing the labels for the combo box selections, corresponding to the values in the listDataObject
isEditable	true/false (false)	Specifies whether or not the user can directly type values into the text area.

com.bowstreet.widget.ControlPicker

extends com.bowstreet.builders.widgets.AbstractComboListWidget

Description: Combo list that displays list of controls for page specified by argument.

Arguments:

Name	Type	Desc
page	String	Page to display controls for. If "all_pages_in_webapp" specified as value for "page" argument, the combo will present a list of controls from all pages in the web app

com.bowstreet.widget.Error

extends com.bowstreet.builders.widgets.AbstractBuilderWidget

Description: This is only meant to be used programmatically by other widgets. It

will display a red error message instead of a widget to indicate that an

error has occurred creating the widget. The error message is specified

via the ErrorWidget constructor.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.FieldChooser

extends com.bowstreet.builders.widgets.AbstractComboListWidget

Description: Display the available fields for use by the page automation builders.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.FileChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Presents a picker which allows the user to select a file, which is used to

populate the text box.

Arguments:

Name	Type	Desc
InitialPath	String (none)	The path that the file dialog will initially open to. For this and the rootDirectory argument, we can start the value with ${bowstreet.rootDirectory}, and the widget will translate that into the actual path of the bowstreet root directory usually <servable content root>/WEB-INF). Note that the value for this argument must be in the Eclipse project workspace, otherwise it will be ignored.
rootDirectory	String	The top level of the file picker, will be the project workspace by default. Note that the value for this argument must be in the Eclipse project workspace, otherwise it will be ignored.
selectionMode	file,directory,both (file)	Whether the user can select files, directories, or both.
title	String (Choose File)	Specify the title of the chooser dialog
filterExtensions	comma-delimited list	Specify list of filters to use- can be of the form *.java or readme*.

com.bowstreet.widget.FileMakerButton

extends com.bowstreet.designer.builders.widgets.ButtonWidget

Description: Button widget which pops up a file-choosing UI

Arguments:

Name	Type	Desc
label	String	label for button

com.bowstreet.widget.HTML

extends com.bowstreet.designer.builders.Widgets.AbstractStyledTextWidget

Description: Simple HTML editor- provides syntax highlighting appropriate for

HTML, XML and JSP pages.

Arguments:

Name	Type	Desc
tab	integer value	Set the tab value for the editor.

com.bowstreet.widget.Label

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Display a non-editable label.

Arguments:

Name	Type	Desc
label	String	The text to display
foreground	one of: blue,cyan,gray,green,magenta, red,yellow	The color of the text to display.

com.bowstreet.widget.List

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Display XML data in a table, and allow sub-Widgets to be used to edit data in individual cells.

Arguments:

Name	Type	Desc
allowAdd	true/false (true)	Can user add row to end of table
allowReorder	true/false (true)	Can user reorder table rows
allowDynamicUpdate	true/false (false)	Allow setting of value without stopping editing in current cell
minColumnSize	Integer	Allow user to specify min col size
CustomChoices		Provides a way for adding arbitrary nodes to a contained tree picker. Example: "Fruits/Pear Fruits/Apple"
useColumnTags	true/false (true)	If set to false, do not add column tags in returned XML value.
offerRightClickMenu	true/false (true)	Whether or not to show right click context menu
cellEditors	IXml	Specifies cell editors to be used in list- same format as <Editors> node in bdef.

com.bowstreet.widget.listInputWidget

extends com.bowstreet.designer.builders.widgets.listWidget

Description: Display XML data in a table, and displays additional row data in specified input widget positioned next to table.

Arguments:

Name	Type	Desc
See List Widget		All List widget arguments are supported, plus those below
inputEditors	IXml	Same format as <editor> node in Bdef
title	String	Title of table/input group.

 

To set Args on individual input field widgets specify <input name</<argument name>

For example: input setArgument("MyInput/ListData","data1,data2,data3"

com.bowstreet.widget.Method

extends com.bowstreet.designer.builders.widgets.AbstractStyledTextWidget

Description: Method editor widget- allows editing a java method, with auto-

indenting, syntax highlighting, and code completion.

Arguments:

Name	Type	Desc
tab	integer	Number of spaces for tabbing (auto-indent)
height	integer	Height of Method widget
linewrap	true/false (false)	Whether or not to wrap lines.

com.bowstreet.widget.ModelChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Presents dialog which allows user to select a model from the Factory

models directory.

Arguments:

Name	Type	Desc
modelProcessor	String	Used to filter which models are shown
externalPropertyName	String	Used to filter which models are shown
externalPropertyValue	String	Used to filter which models are shown

com.bowstreet.widget.PageLocation

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description:PageLocationWidget- compound widget which allows user to specify

location of control on page.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.Password

extends com.bowstreet.designer.builders.widgets.TextFieldWidget

Description:Extends TextFieldWidget, text field which displays "*" rather than

typed letters.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.ProfileSet

com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description:Displays list of profile sets, allows user to select profile set(s).

Arguments:

Name	Type	Desc
multiSelect	true/false (false)	Whether to allow selection of multiple profile sets.

com.bowstreet.widget.RadioBox

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description:RadioBox

Arguments:

Name	Type	Desc
listData	comma-delimited list	Data returned when radio box selection is selected
listLabels	comma-delimited list	List of labels for radio boxes
selectItem	String	Value selected when radio box widget is first displayed.
listDataOjbect	instance of java.util.Collection	Data returned when radio box selection is selected.
listLabelsObject	instance of java.util.Collection	List of labels for radio boxes

com.bowstreet.widget.Reference

extends com.bowstreet.designer.builders.widgets.AbstractBuilderWidget

Description: Displays dialog which allows user to select indirect reference from web

app.If the contained widget (specified by the editor argument) is a

chooser type widget, the dialog will have two tabs, one for indirect

references and one for the other chooser dialog.

Arguments:

Name	Type	Desc
editor	String	An IXml element which describes the widget to be used by the Reference widget, with any arguments which are needed for the editor. If not specified, defaults to TextFieldWidget
Variables	true/false (true)	Whether or not to show variables in picker.
Methods	true/false (true)	Whether or not to show methods in picker.
Inputs	true/false (true)	Whether or not to show inputs in picker.
Java	true/false (true)	Whether or not to show Java choice in picker.
useCurlyBrace	true/false (true)	Whether or not to wrap the returned result with ${}

com.bowstreet.widget.Schema

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description:Chooser type widget which displays schema types and elements from

schemas in webapp.

Arguments:

Name	Type	Desc
filterNoNamespace	true/false (false)	If true, only show schemas which have an associated target namespace.
additionalSchemaTypes	comma-delimited list	Used to specify list of additional types to be displayed in schema chooser.

 

com.bowstreet.widget.TextArea

extends com.bowstreet.designer.builders.widgets.AbstractTextWidget

Description:TextArea widget

Arguments:

Name	Type	Desc
height	integer	Height of TextArea widget
isEditable	true/false (true)	Whether or not the text area is editable.

com.bowstreet.widget.TextField

extends com.bowstreet.designer.builders.widgets.AbstractTextWidget

Description:TextField widget

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.TypedSourceChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Used by builders like Data Page to select a structured input

source. Lists variables, schema elements, and two special types for

creating new types from elements in an HTML page.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.VariableElements

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: VariableElementsWidget- chooser type widget which will show

elements appropriate to the variable's type based on the schema

associated with the builder.

Arguments:

Name	Type	Desc
variableName	String	Name of variable
trimParentPath	true/false	Whether or not to trim off the parent path from the schema path selected.

com.bowstreet.widget.WebAppMethod

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: Similar to ActionChooserWidget, initialized with showMethodsWithArguments set to true, showSpecialActions set to

false, and an AcceptanceFilter set to a filter that only allows method

actions.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.WebAppPage

Description:Combo box list of web app pages.

Arguments:

Name	Type	Desc
addBlankChoice	true/false (false)	Whether or not to add a blank choice at the top of the list of pages
addAllPages	true/false (false)	Whether or not to add an "All Pages" option in the list of pages
showLinkedModelPages	true/false (false)	Whether or not to show linked model pages.

com.bowstreet.widget.WebAppVariableType

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description:Picker for variable builder to display possible variable types.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.WebAppVariable

extends com.bowstreet.designer.builders.widgets.AbstractComboListWidget

Description:Combo box list of variables in web app.

Arguments:

Name	Type	Desc
none

com.bowstreet.widget.ResourceBundleChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description:Allows user to select a resource bundle file name.The chooser is populated based on all *.properties files in the Factory's dynamic class loading directories (specified via bowstreet.dynamic.class.load.path property in the bowstreet property files).

Arguments:

Name	Type	Desc
searchDirectory	string	Comma-delimited list of paths to search to populate the chooser (in addition to dynamic class dirs). Can be either a fully qualified path, or can use ${bowstreet.rootDirectory/<path> syntax

com.bowstreet.widget.TreeChooser

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description:A generic Tree Chooser widget- it will take a collection of strings and create a tree chooser from it.

<![if !supportEmptyParas]> <![endif]>

Arguments:

Name	Type	Desc
title	string	The title to be displayed on the title bar of the chooser dialog.
treedata	Either a comma-delimited String, or a java.util.Collection object containing Strings.	Values should be '/' delimited, for example a/b/c will be displayed as: A -B -C
allowDirSelection	true/false	If true, non-terminal nodes can be selected and returned to the text field. If false, only terminal nodes can be selected.

com.bowstreet.widget.ListChooserWidget

extends com.bowstreet.designer.builders.widgets.AbstractChooserWidget

Description: A generic chooser widget that displays a chooser dialog containing a SWT List control.The content of the list is set by arguments passed to the widget.

Arguments:

Name	Type	Desc
title	string	Title to be displayed on the title bar of the chooser dialog.
multiSelect	true/false	If true, allow multiple items to be selected
separatorChar	String	If multiSelect is being used, use this char as the delimiter between the choices in the returned string.
listData	Either a comma-delimited String, or a java.util.Collection object	If a Collection is passed in, each item will be converted to a String via toString(), and those Strings are used to populate the list.