Guidewire PolicyCenter PCF Format Reference

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.

AbstractTileAction

top

Subclasses:

TileActionIterator TileAction

AbstractTileInput

top

Subclasses:

BarInput CurrencyInput DateInput InputDivider Label MonetaryAmountInput PrivacyInput TextAreaInput TextInput TileInputSetRef

AbstractTile

top

Tile, a basic element of a dashboard

Child elements:

Require TileActions Variable

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
title	Expression (String)		The title of the tile. The title is shown on the top of the tile.
viewMoreAction	Statement		The view more action. The 'View more' link is shown in the tile footer.
viewMoreLabel	Expression (String)	DisplayKey.get("Web.Tile.ViewMore")	The view more label of the tile. By default 'View More'
viewMoreVisible	Expression (Boolean)		An expression that indicates if the view more link is visible.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AbstractToolbarButton

top

Subclasses:

AddButton CheckedValuesToolbarButton PickerToolbarButton RemoveButton SearchItem ToolbarButton ToolbarRangeInput

AbstractTopElement

top

Subclasses:

AbstractPanelDef AbstractTile AbstractWizardStepsDef AcceleratedMenuActions ColumnDashboard EntryPoint ExitPoint Forward InfoBar InputSet JobWizard LocationGroup MenuActions MenuItemSet MenuLinks MenuTree ModalCell Page Popup PopupWizard RowSet Screen SystemAlertBar TabBar TileInputSet ToolbarButtonSet Wizard Worksheet

AbstractWizardStepsDef

top

Subclasses:

WizardStepGroup WizardStepSet

AbstractWizardStepsRef

top

Subclasses:

JobWizardStep WizardStepGroupRef WizardStepIterator WizardStep WizardStepSetRef

AcceleratedMenuActions

top

An element containing accelerated action links in the left menu bar

Child elements:

Require Variable StandardMenuElement AbstractLink Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
title	Expression (String)		An optional title for this widget, if set, generates a title bar that can collapse and expand this widget
titleIcon	Expression (String)		An optional title icon for this widget, if set, generates a title bar that can collapse and expand this widget
titleIconType	IconTypeEnum		An enumeration of icon types that determine what the 'titleIcon' property on the widget is referring to.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AddButton

top

A button to add new entries for the nearest iterator control after. This button is only visible when the associated iterator control enables "add" (i.e., with "toAdd", "toCreateAndAdd" or "pickLocation" defined). If you want to add both "add" and "remove" buttons to the iterator, you can use <IteratorButtons> instead.

Child elements:

AbstractAddMenuItem

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		An optional Gosu expression used to convert a picked value into a value that can be added to the iterator. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
flags	String		A very special expression defining what flags (see ToolbarFlag) must be checked for the toolbar button to be available (= not grayed out). All processing of flags happens on the browser-side. The flags syntax is a comma-separated list of predicates (with no space after each comma), and all predicates must be satisfied for the button to be available. Each predicate consists of a operator followed by a space and then the name of a ToolbarFlag. For instance, flags="one Foo,no Bar" means "only available if there is exactly one Foo checkbox checked and no Bar checkboxes checked". The available operators are: one, two, any, all, no, exists (same as any).
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		Label for this element
pickLocation	Statement		Specifies the picker popup to use when adding new elements to the iterator, as a Gosu statement of the format "[popup name].push(...)"
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
toCreateAndAdd	Expression (Object)		An optional Gosu expresssion to override the default "toCreateAndAdd" behavior defined by the associated iterator. The return type must match the entry type of the iterator. When the iterator is not under a List-Detail-Panel, this expression can alternatively returns an array of entry data, in which case multiple new entries will be added at the same time.The list of checked entry data under the associated Iterator is exposed to this expression as "CheckedValues", which can be used to copy from a selected row when creating a new row. See the same attribute on RowIterator for more info.
tooltip	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AddMenuItemIterator

top

Creates as many copies of its AddMenuItem content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside an AddButton.

Child elements:

IteratorSort AbstractAddMenuItem

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AddMenuItem

top

A menu item to add new entries for the specified iterator.

Child elements:

AbstractAddMenuItem

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		An optional Gosu expression used to convert a picked value into a value that can be added to the iterator. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		Label for this element
pickLocation	Statement		Specifies the picker popup to use when adding new elements to the iterator, as a Gosu statement of the format "[popup name].push(...)"
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
toCreateAndAdd	Expression (Object)		An optional Gosu expresssion to override the default "toCreateAndAdd" behavior defined by the associated iterator. The return type must match the entry type of the iterator. When the iterator is not under a List-Detail-Panel, this expression can alternatively returns an array of entry data, in which case multiple new entries will be added at the same time.The list of checked entry data under the associated Iterator is exposed to this expression as "CheckedValues", which can be used to copy from a selected row when creating a new row. See the same attribute on RowIterator for more info.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AddressAutoFillInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		A helpful description of what fields are being autofilled by other fields when the user hovers the mouse over the autofill button
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AddressAutoFillRangeInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
multiSelect	Boolean	false	Indicates that this input is a multiselect. If true, the value expression should refer to an array.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
shuttleList	Boolean	false	If true, the input will be rendered as a "shuttle" input, allowing the user to select options by moving them from one list to another.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AddressAutoFillTextInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AddressBookContactCell

top

A ListView cell specialized for an AddressBook Contact.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
allowEditContact	Expression (boolean)	true	Specify if the contact is editable when the link is clicked
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
forceContactSubtype	Expression (gw.lang.reflect.IType)		Forces the "type" of this Contact column to be that specified by the expression (default gosu). If unspecified, the "type" of this Contact column is determined by the type of the value expression. Note that one can coerce the type of the value expression statically by casting it, as in "Foo.Contact as Person". Therefore, this attribute is really only useful when you want to force to a type that's determined dynamically.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
newContactMenu	String		The ID of a MenuItemSet pcf file that will be included in the picker menu. This MenuItemSet pcf file contains a MenuItem for which you want to create new contacts. The default "NewContactPickerMenuItemSet" contains all subtypes of entity.Contact. To hide the NewContact menu completely set newContactMenu="BlankNewContactPickerMenuItemSet()". Available alternative is the NewPersonOnlyPickerMenuItemSet. It can also be a custom MenuItemSet pcf file. The default prototype of a newContactMenu menu item set is the following: SOME_MENUITEMSET(requiredContactType : Type, parentContact : Contact) If the menu item set is given without any parameter list (e.g. newContactMenu="NewPersonOnlyPickerMenuItemSet"), then the values obtained (or defaulted) from forceContactSubtype and parentContact are passed to the menu item set. If the menu item set contains a parameter list (e.g. newContactMenu="SomeOtherPickerMenuItemSet(entity.Company, 123, 456)"), then the specified parameter list will be passed down to the menu item set
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
parentContact	Expression (entity.Contact)		Specify the contact which would become the "parent" of the returned contact from this picker. If none is specified, then it is set to null by default. The main purpose of the parentContact is for passing down to the menu item set as mentioned below
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)		Overrides the location of the search page.
setNoneSelected	Statement		Overrides the action on "none selected" option in the drop down menu. The default behavior for the "none selected" is setting the value expression of this widget to null. However, if the value expression is not a simple property (e.g. a function), then this attribute can be used to override the "none selected" action correctly (e.g. if "setter" is provided for this widget, then "setNoneSelected" should also be provided. )
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.Contact	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

AddressBookContactInput

top

A ContactInput specialized for Contact fields on the AddressBook. This input has a pre-defined AddressBookContactDetails page, AddressBookPicker page, NewAddressBookContact page, and NewAddressBookContact menu

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
allowEditContact	Expression (boolean)
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
forceContactSubtype	Expression (gw.lang.reflect.IType)		Forces the "type" of this Contact input to be that specified by the expression (default gosu). If unspecified, the "type" of this Contact column is determined by the type of the value expression. Note that one can coerce the type of the value expression statically by casting it, as in "Foo.Contact as Person". Therefore, this attribute is really only useful when you want to force to a type that's determined dynamically.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
newContactMenu	String		The ID of a MenuItemSet pcf file that will be included in the picker menu. This MenuItemSet pcf file contains a MenuItem for which you want to create new contacts. The default "NewContactPickerMenuItemSet" contains all subtypes of entity.Contact. To hide the NewContact menu completely set newContactMenu="BlankNewContactPickerMenuItemSet()". Available alternative is the NewPersonOnlyPickerMenuItemSet. It can also be a custom MenuItemSet pcf file. The default prototype of a newContactMenu menu item set is the following: SOME_MENUITEMSET(requiredContactType : Type, parentContact : Contact) If the menu item set is given without any parameter list (e.g. newContactMenu="NewPersonOnlyPickerMenuItemSet"), then the values obtained (or defaulted) from forceContactSubtype and parentContact are passed to the menu item set. If the menu item set contains a parameter list (e.g. newContactMenu="SomeOtherPickerMenuItemSet(entity.Company, 123, 456)"), then the specified parameter list will be passed down to the menu item set
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
parentContact	Expression (entity.Contact)		Specify the contact which would become the "parent" of the returned contact from this picker. If none is specified, then it is set to null by default. The main purpose of the parentContact is for passing down to the menu item set as mentioned below
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)		Overrides the location of the search page.
setNoneSelected	Statement		Overrides the action on "none selected" option in the drop down menu. The default behavior for the "none selected" is setting the value expression of this widget to null. However, if the value expression is not a simple property (e.g. a function), then this attribute can be used to override the "none selected" action correctly (e.g. if "setter" is provided for this widget, then "setNoneSelected" should also be provided. )
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showSearchInMenu	Boolean	true	If false, hide the AddressBook search menu item.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.Contact	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AlertBar

top

A single line for displaying a notification as a link with a dismiss button

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
allowDismiss	Boolean	true	Default to true. If set to false, there would be no dismiss button for the user to dismiss the alert.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
dismissed	Expression (Boolean)		Binds a boolean variable to the dismissed state of the alert, allowing the alert to be dismissed/re-shown programatically.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

AltGroupCell

top

An alternative version of the GroupCell. This contains a two menu buttons next to the cell, one of which searches via the GroupSearchPopup and the other of which selects a group via the OrganizationGroupTreePopup.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.Group	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

AltGroupInput

top

An alternative version of the GroupInput. This contains a two menu buttons next to the input, one of which searches via the GroupSearchPopup and the other of which selects a group via the OrganizationGroupTreePopup.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.Group	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AltUserCell

top

An alternative version of the UserCell. This contains a single menu button next to the user cell that navigates to the UserSearchPopup.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.User	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

AltUserInput

top

An alternative version of the UserInput. This contains a single menu button next to the user input that navigates to the UserSearchPopup.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.User	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AssigneeCell

top

A ListView cell specialized for an Assignee

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
assignable	Expression (Object)
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
filter	Expression (Object)
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
newLabel	Expression (String)
newValue	Expression (Object)
noneSelectedLabel	Expression (String)
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
optionLabel	Expression (String)
outputConversion	Expression (String)
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
styleClass	LinkStyleClass
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)
validationLabel	Expression (String)
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

AssigneeInput

top

A ContactInput specialized for Contact fields on an Assignable entity. This input has a pre-defined ContactDetails page, AddressBookPicker page, NewContact page, and NewContact menu

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
assignable	Expression (Object)
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

AxisType

top

Value:	Description:
Category
Date
Number

Badge

top

Attribute:	Type:	Default:	Description:
backgroundColor	Expression (gw.api.web.color.GWColor)		Deprecated. Use Badge Style. The color of the badge's background. If not set, will default to the theme's `All Clear` color.
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		A BadgeStylesEnum value. Changes the visual appearance of the element.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
text	Expression (String)		The text to display in the badge.
textColor	Expression (gw.api.web.color.GWColor)		Deprecated. Use Badge Style. The color of the text. If not set, will default to the theme's `light` text color.
useLargeStyle	Boolean	false	If true, the badge will appear larger.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the badge.

BadgeProperties

top

Attribute:	Type:	Default:	Description:
backgroundColor	Expression (gw.api.web.color.GWColor)		Deprecated. Use Badge Style. The color of the badge's background. If not set, will default to the theme's `All Clear` color.
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		A BadgeStylesEnum value. Changes the visual appearance of the element.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
text	Expression (String)		The text to display in the badge.
textColor	Expression (gw.api.web.color.GWColor)		Deprecated. Use Badge Style. The color of the text. If not set, will default to the theme's `light` text color.
useLargeStyle	Boolean	false	If true, the badge will appear larger.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the badge.

BarCell

top

A widget that represents a percentage value as a bar icon. Unlike Progress widget, this widget is static and does not refresh its value automatically

Child elements:

Reflect ColumnFooter

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
highInclusive	Expression (Boolean)		Boolean expression which, if true, will render the widget in the high style when the percentage is equal to the highThreshold. Defaults to true.
highThreshold	Expression (java.lang.Double)		An option numeric expression. If set, this widget will be rendered in high style when the percentage is higher than (or equal to if "highInclusive" is true) this number
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
lowInclusive	Expression (Boolean)		Boolean expression which, if true, will render the widget in the low style when the percentage is equal to the lowThreshold. Defaults to true.
lowThreshold	Expression (java.lang.Double)		An option numeric expression. If set, this widget will be rendered in low style when the percentage is lower than (or equal to if "lowInclusive" is true) to this number.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
percentage	Expression (java.lang.Double)		A numeric expression that returns the percentage value between 0 to 100
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
status	Expression (String)		An optional expression, if specific, the return value will be displayed along with the icon
switchHighLowStyle	Boolean	false	An optional Boolean attribute. If set, the low part of the bar will be rendered in high style and the high part of the bar will be rendered in low style. Default to false.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

BarInput

top

A widget that represents a percentage value as a bar icon. Unlike Progress widget, this widget is static and does not refresh its value automatically

Child elements:

LayoutConfig

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
highInclusive	Expression (Boolean)		Boolean expression which, if true, will render the widget in the high style when the percentage is equal to the highThreshold. Defaults to true.
highThreshold	Expression (java.lang.Double)		An option numeric expression. If set, this widget will be rendered in high style when the percentage is higher than (or equal to if "highInclusive" is true) this number
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
lowInclusive	Expression (Boolean)		Boolean expression which, if true, will render the widget in the low style when the percentage is equal to the lowThreshold. Defaults to true.
lowThreshold	Expression (java.lang.Double)		An option numeric expression. If set, this widget will be rendered in low style when the percentage is lower than (or equal to if "lowInclusive" is true) to this number.
percentage	Expression (java.lang.Double)		A numeric expression that returns the percentage value between 0 to 100
status	Expression (String)		An optional expression, if specific, the return value will be displayed along with the icon
switchHighLowStyle	Boolean	false	An optional Boolean attribute. If set, the low part of the bar will be rendered in high style and the high part of the bar will be rendered in low style. Default to false.
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

BooleanDropdownInput

top

An Input that renders as a drop-down list. Consider using TypeKeyInput or RangeInput instead.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.Boolean	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

BooleanRadioCell

top

A Cell that renders as radio buttons

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.Boolean	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

BooleanRadioInput

top

An Input with extra attributes for a Boolean field

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
falseLabel	Expression (Object)		Expression giving the label of the "false" option
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Optional icon to show in readonly mode when the underlying value is true
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
stacked	Expression (Boolean)	false	If true, the contents of the Widget will be stacked vertically.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
trueLabel	Expression (Object)		Expression giving the label of the "true" option
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (Object)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.Boolean	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

BulletPointTextInput

top

An Input which precedes its value with a bullet point

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ButtonCell

top

A cell which contains a single button. Like ToolbarButton, this button may have MenuItems underneath it, which creates a drop-down menu under the button.

Child elements:

Reflect ColumnFooter StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		The action to invoke when this button is clicked by the user.
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
enableSort	Boolean	false	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideChildrenIfReadOnly	Boolean	false	If true, this button will not be shown in read-only mode if it has child MenuItems but no action.
hideIfDisabled	Expression (Boolean)	true	If set to true, this widget will not be displayed when the action is disabled. Default to true.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
value	Expression (Object)		The value to be displayed on the button.
valueType	Type reference	java.lang.String	The type of the value expression.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

ButtonInput

top

An input which contains a single button. Like ToolbarButton, this button may have MenuItems underneath it, which creates a drop-down menu under the button.

Child elements:

LayoutConfig StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		The action to invoke when this button is clicked by the user.
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
hideChildrenIfReadOnly	Boolean	false	If true, this button will not be shown in read-only mode if it has child MenuItems but no action.
hideIfDisabled	Expression (Boolean)	true	If set to true, this widget will not be displayed when the action is disabled. Default to true.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
value	Expression (Object)		The value to be displayed on the button.
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

Calendar

top

A Calendar with month and week views.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
calendarSource	Expression (Object)
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
context	String
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

CalendarType

top

Supported calendar types

Value:	Description:
Gregorian	Gregorian calendar
JapaneseImperial	Japanese imperial calendar

CardIterator

top

Iterates an arbitrary number of cards

Child elements:

Require Variable IteratorSort Card

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)	true	Boolean expression which, if false, completely hides the widget and all its children

Card

top

Used within a CardViewPanel to contain the content of one card

Child elements:

ChildOfPanel AbstractPanelDef

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
onSelect	Statement		An optional expression that is executed when this card is selected.
selectOnEnter	Expression (Boolean)		An optional Boolean exprssion which, if returns true, will select this card upon entering the enclosing CardView (e.g., when enter the Page, or select a new row in the ListDetailPanel that contains this CardView).
selectOnNewEntry	Boolean	false	If true, this card will be selected when a new entry is added to the parent ListDetailPanel (if any). Default to false. When the ListDetailPanel contains multiple cards but data of a new list entry can only be entered from one of the cards, you may want to set the flag on that card so that the user can start entering data right away.
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. If specifed, this will be used for the card's tab in the CardView tab bar.
title	Expression (String)		The Card's title, used in the card's tab in the CardView tab bar.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

CardViewPanel

top

A collection of "Cards", or sub-panels, of which only one card at a time is visible. A set of tabs are shown for switching between cards.

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget CardIterator Card Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
hideTabIfSingle	Boolean	false	If true, hides the tab when no more than one card is visible. Default to false.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.

CellIterator

top

Creates as many copies of its Cell content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside a Row.

Child elements:

IteratorSort ToolbarFlag AbstractCell

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.

ChartOrientation

top

Value:	Description:
Horizontal
Vertical

ChartPanel

top

Child elements:

Require Variable DomainAxis RangeAxis DataSeries DualAxisDataSeries Code

Attribute:	Type:	Default:	Description:
allowSeriesToggling	Boolean	true	If true, chart series' visibility can be toggled on and off by clicking on it or on the corresponding legend entry
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
displayLegend	Boolean	true	If true, displays a legend with a title for each data series. Default to true
expressionHeight	Expression (java.lang.Double)		An Gosu expression setting the height in pixels of this element.
expressionWidth	Expression (java.lang.Double)		An Gosu expression setting the width in pixels of this element.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
insetPadding	Expression (java.lang.Integer)	0	Expression for the inset padding. Inset padding is the number of padding pixels from the boundary of the chart to any of its contents. The default value is 0.
label	Expression (String)		An expression for the label (title) of this chart
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
legendPosition	LegendPosition	top	Determines the position of the legend relative to the chart. Defaults to top.
legendWidth	Expression (java.lang.Integer)	30	The width of the legend section when legend is positioned right or left of the chart, expressed as the percentage of the total chart panel width. Ignored for top and bottom legend positioning. The default value is 30.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
type	ChartType		One of the enumerated chart types
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ChartTile

top

A Tile containing a single ChartPanel and optionally a TileInputColumn.

Child elements:

Require Variable TileActions TileChartPanel TileInputColumn

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
title	Expression (String)		The title of the tile. The title is shown on the top of the tile.
viewMoreAction	Statement		The view more action. The 'View more' link is shown in the tile footer.
viewMoreLabel	Expression (String)	DisplayKey.get("Web.Tile.ViewMore")	The view more label of the tile. By default 'View More'
viewMoreVisible	Expression (Boolean)		An expression that indicates if the view more link is visible.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

ChartType

top

Value:	Description:
Area
Bar
Donut
Line
Pie
StackedBar
TimeSeries
XYLine

CheckBoxCell

top

A ListView cell containing a checkbox which is bound to some value, rather than being used to select rows.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.Boolean	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

CheckBoxGroupInput

top

An input bound to an array or list which renders as a group of checkboxes.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionIcon	Expression (String)		An optional expression to specify an icon for each option. The option value is exposed as "VALUE". The return value's type is determined by OPTION_ICON_TYPE
optionIconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. The option value is exposed as "VALUE". If not set will default to its font color.
optionIconType	IconTypeEnum		An enumeration of icon types that determine what the 'optionIcon' property on the widget is referring to.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

CheckBoxInput

top

An Input that renders as a check box

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
suppressEmptyLabel	Boolean	false	If this attribute is true, and the label is empty, then the space normally set aside for a label will be omitted.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueLabel	Expression (Object)		An optional expression, if set, the value of which will be displayed to the right of the checkbox.
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.Boolean	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

CheckedValuesMenuItemIterator

top

Creates as many copies of its CheckedValueMenuItem content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside an AddButton.

Child elements:

IteratorSort AbstractCheckedValuesMenuItem

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

CheckedValuesMenuItem

top

A menu item under a CheckedValuesToolbarButton which handles checked rows in the associated RowIterator

Attribute:	Type:	Default:	Description:
allCheckedRowsAction	Statement		The all checked row action is a Gosu expression that processes all rows that are checked in the coresponding listview/iterator. The expression is passed a new symbol named CheckedValues. This symbol contains a list of values that are checked. Unlike "checkedRowAction", this expression does not commit the data changes for you. If the page is in edit mode, the changes will be committed when the page is committed.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
checkedRowAction	Statement		The checked row action is a Gosu expression that processes each row that is checked in the corresponding listview/iterator. Each row that is checked is passed through this expression. The exposed symbol is the entry symbol defined in the listview/iterator After all rows have been processed and the page is in read-only mode, a new bundle is created and all changes are commited to the database. If the page is in edit mode nothing is commited.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
pickValue	Expression (context-dependent)		A Gosu expression which defines the value (or array of values) to return from the popup containing this widget when it is clicked.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

CheckedValuesToolbarButton

top

A button in a toolbar which handles checked rows of the associated RowIterator

Child elements:

AbstractCheckedValuesMenuItem

Attribute:	Type:	Default:	Description:
allCheckedRowsAction	Statement		The all checked row action is a Gosu expression that processes all rows that are checked in the coresponding listview/iterator. The expression is passed a new symbol named CheckedValues. This symbol contains a list of values that are checked. Unlike "checkedRowAction", this expression does not commit the data changes for you. If the page is in edit mode, the changes will be committed when the page is committed.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
checkedRowAction	Statement		The checked row action is a Gosu expression that processes each row that is checked in the corresponding listview/iterator. Each row that is checked is passed through this expression. The exposed symbol is the entry symbol defined in the listview/iterator After all rows have been processed and the page is in read-only mode, a new bundle is created and all changes are commited to the database. If the page is in edit mode nothing is commited.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flags	String		A very special expression defining what flags (see ToolbarFlag) must be checked for the toolbar button to be available (= not grayed out). All processing of flags happens on the browser-side. The flags syntax is a comma-separated list of predicates (with no space after each comma), and all predicates must be satisfied for the button to be available. Each predicate consists of a operator followed by a space and then the name of a ToolbarFlag. For instance, flags="one Foo,no Bar" means "only available if there is exactly one Foo checkbox checked and no Bar checkboxes checked". The available operators are: one, two, any, all, no, exists (same as any).
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		Label to render.
pickValue	Expression (context-dependent)		A Gosu expression which defines the value (or array of values) to return from the popup containing this widget when it is clicked.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
tooltip	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

ChildOfPanel

top

Subclasses:

ImageAction ImageMediaObject Image PanelDivider PanelIterator PanelRef Spacer

Choice

top

One of several options for viewing different fields in a DetailView. Is rendered as a radio button with all the contained widgets made avaialable / unavailable depending on whether that button is selected. Typically you have multiple Choice elements with the same "value" attribute and different "option" attributes.

Child elements:

AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
option	Expression (Object)		A specific value such as "true" or a typecode. If the current value of "value" equals this option, then the contents are available
value	Expression (Object)		The value this choice element binds to, typically a Boolean or Typekey field in Gosu.
valueType	Type reference		The type of the value expression.

ClaimAssociationsCell

top

A ListView cell specialized for an array of ClaimInAssociations.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

Code	top
A Gosu code block that can be embedded in a PCF file. It's usefully for UI data-manipulation or navigation logic that is only applicable to this particular PCF file. Do NOT put logic that is sharable by multiple PCF files or belongs to DM layer here. Any modifications to the code block content will not be upgraded. *Use with caution.*
No attributes

ColumnDashboard

top

Dashboard layout, can contain up to two DashboardColumns.

Child elements:

Require Variable DashboardColumn

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

ColumnFooter

top

Renders its content as the footer cell of this column. Do NOT this to generate footer cell which contains simple readonly content, which can be handled by the "footerLabel" attribute of the Cell. This element is only applicable when the containing Row is iterated by a RowIterator.

An Input that displays the field as an obscured password, and has an additional "confirm" input

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmLabel	Expression (Object)		Gosu expression for the label of the additional confirm input
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
oldPasswordLabel	Expression (Object)		If 'requireOldPassword' is true, then this will be used as the label for the old password input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
passwordValidationExpression	Expression (Object)		Validation expression that is run on the new password before it is hashed.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
requireOldPassword	Expression (Boolean)	false	Boolean expression which, if true, requires the user to correctly enter their old password before their password can be changed.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ContentInput

top

A DetailView field containing arbitrary content, such as links.

Child elements:

LayoutConfig AbstractLink

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

CovTermDirectInput

top

An Input specialized for direct coverage term.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

CurrencyCell

top

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
exchangeRate	Expression (java.lang.Double)		An optional expression to return a number. If specified, the return value will be used to override the default exchange rate when calculating amount for the secondary MoneyComponent. Only meaningful, when the underlying MoneyComponent is linked to a secondary MoneyComponent with a different currency. Normally, you do NOT want to specify this attribute, thus allow the widget to look up the proper exchange rate from the primary currency to the secondary currency. Use with caution.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	gw.api.financials.CurrencyAmount	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

CurrencyInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
exchangeRate	Expression (java.lang.Double)		An optional expression to return a number. If specified, the return value will be used to override the default exchange rate when calculating amount for the secondary MoneyComponent. Only meaningful, when the underlying MoneyComponent is linked to a secondary MoneyComponent with a different currency. Normally, you do NOT want to specify this attribute, thus allow the widget to look up the proper exchange rate from the primary currency to the secondary currency. Use with caution.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	gw.api.financials.CurrencyAmount	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

DashboardColumn

top

Wrapper for Tiles that aligns them vertically.

Child elements:

Require Variable AbstractTile TileRef

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.

DataSeries

top

Attribute:	Type:	Default:	Description:
categoryLabel	Expression (String)		An expression that evaluates to the label of each category, as well as the name of the general group in which to place this series entry. Names each slice in case of Pie/Donut charts.
dataValueType	Type reference		The type of the elements in the collection defined by dataValues
dataValues	Expression (Object)		The expression for the values of this data. Must be an array, list, or query.
fillColor	Expression (context-dependent)		A fill color used for this series. For pie charts you need to specify a list of colors corresponding to categories.
label	Expression (String)		An expression for the label of the data series. Any non-empty value is ignored for Pie/Donut charts as these accept only single DataSeries and do not need label-based differentiation
strokeColor	Expression (context-dependent)		A stroke color used for this series. For pie charts you need to specify a list of colors corresponding to categories.
value	Expression (Object)		An expression that maps the yValue in component type of the values. The component object is accessable via the value symbol, i.e value.getY(). The returned value must be a number.
xValue	Expression (Object)		An expression that maps the xValue in the component type of the values. The component object is accessible via the value symbol, such as with value.getX(). The returned value must be a number or date. Not applicable for categorical charts.

DateCell

top

A ListView cell with extra attributes for a Date field

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
dateFormat	DateTimeType		The format of the "day/month/year" portion of the date. Options are "short", "medium", and "long". If a date format is specified and a time format is not, only the date will be shown.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
timeFormat	DateTimeType		The format of the "hour/minute/AMorPM" portion of the date. Options are "short", "medium", and "long". If a time format is specified and a date format is not, only the time will be shown.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.util.Date	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

DateCriterionChoiceInput

top

An Input specialized for DateCriteria fields

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
chosenOptionVisible	Boolean	false	Determines if the ChosenOption field will be visible
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.DateCriterionChoice	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

DateInput

top

An Input with extra attributes for Date fields

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
dateFormat	DateTimeType		The format of the "day/month/year" portion of the date. Options are "short", "medium", and "long". If a date format is specified and a time format is not, only the date will be shown.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
timeFormat	DateTimeType		The format of the "hour/minute/AMorPM" portion of the date. Options are "short", "medium", and "long". If a time format is specified and a date format is not, only the time will be shown.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.util.Date	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

DateTimeInput

top

A DateTime Input with separate fields for viewing/editing the date and time components of a java.util.Date value

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
dateEditable	Expression (Boolean)
dateVisible	Expression (Boolean)
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onChange	Statement
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
timeEditable	Expression (Boolean)
timeVisible	Expression (Boolean)
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.util.Date	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

DateTimeType

top

Value:	Description:
short
medium
long

DefaultButtonType

top

Default wizard button type

Value:	Description:
none	No default button
next	Next button is default
prev	Prev button is default
cancel	Cancel button is default
finish	Finish button is default

DetailViewPanel

top

A panel made up of Input Columns and Input Sections whose content is formatted as a series of label / value pairs

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget Layout InputHeaderSection AbstractInput InputColumn InputFooterSection Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
columnDivider	Boolean	true	If true, show divider between child columns. Default to true.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
highlighted	Expression (Boolean)		!Deprecated. Use panelStyle. If true, the Panel will have a background color specified via the SASS variable. Overrides the value in panelStyle.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inline	Boolean	false	!Deprecated. If true, the DetailView will be an inline element. Default to false.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

DetailViewTile

top

A panel whose content is formatted as a series of label / value pairs.

Child elements:

Require Variable TileActions BadgeProperties PerformanceIndicatorRow TileInputColumn

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
columnDivider	Boolean	false	Show divider between child columns. Defaults to false.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
title	Expression (String)		The title of the tile. The title is shown on the top of the tile.
viewMoreAction	Statement		The view more action. The 'View more' link is shown in the tile footer.
viewMoreLabel	Expression (String)	DisplayKey.get("Web.Tile.ViewMore")	The view more label of the tile. By default 'View More'
viewMoreVisible	Expression (Boolean)		An expression that indicates if the view more link is visible.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

DocumentTemplateInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

DomainAxis

top

Attribute:	Type:	Default:	Description:
dateFormat	DateTimeType		The format of the "day/month/year" portion of the date. Options are "short", "medium", and "long". If a date format is specified and a time format is not, only the date will be shown.
label	Expression (String)		An expression for the label of this axis
labelOrientation	LabelOrientation	Horizontal	The orientation of the axis labels
lowerBound	Expression (java.lang.Double)		The lower bound expression for the axis range. If omitted the minimum value of all the data series is used. Ignored for a category axis
timeFormat	DateTimeType		The format of the "hour/minute/AMorPM" portion of the date. Options are "short", "medium", and "long". If a time format is specified and a date format is not, only the time will be shown.
upperBound	Expression (java.lang.Double)		The upper bound expression for the axis range. If omitted the maximum value of all the data series is used. Ignored for a category axis
useWholeNumbers	Boolean	false	If true, and if the values are numeric, tick values will only be display as whole numbers

Download

top

Value:	Description:
true	Download using the configured default disposition, inline or attachment
false	Do not download
attachment	Download as an attachment
inline	Download as an inline view

DualAxisDataSeries

top

A SecondaryDataSeries element ...

Attribute:	Type:	Default:	Description:
axisLabel	Expression (String)		The expression for the label of the second axis.
categoryLabel	Expression (Object)		An expression that evaluates to the label of each category, as well as the name of the general group in which to place this series entry. Should evaluate to the same Object as the other DataSeries elements defined previously.
dataValueType	Type reference		The type of the elements in the collection defined by dataValues
dataValues	Expression (Object)		The expression for the values of this data. Must be an array, list, or query
fillColor	Expression (context-dependent)		A fill color used for this series. For pie charts you need to specify a list of colors corresponding to categories.
lowerBound	Expression (java.lang.Double)		The lower bound expression for a manual axis range.
seriesLabel	Expression (String)		An expression for the label of the data series
strokeColor	Expression (context-dependent)		A stroke color used for this series. For pie charts you need to specify a list of colors corresponding to categories.
upperBound	Expression (java.lang.Double)		The upper bound expression for a manual axis range.
useWholeNumbers	Boolean	false	A Boolean where, if true, the tick values will only be display as whole numbers
value	Expression (Object)		An expression that maps the series value in component type of the values. The component object is accessable via the values symbol, i.e. value.getFoo(). The returned value must be a number or date.
xValue	Expression (Object)		An expression that maps the xValue in the component type of the values. The component object is accessible via the value symbol, such as with value.getX(). The returned value must be a number or date.

EditButtons

top

A set of pre-included toolbar buttons for edit control. Includes edit, update, & cancel.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
cancelDefault	Boolean	false	If true, the Cancel button will be the default button which can be invoked by Enter key.
cancelLabel	Expression (String)		Alternative label for the cancel button
cancelShortcut	String	L	Keyboard shortcut character for cancel button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
cancelVisible	Expression (Boolean)		Boolean expression specifying whether the cancel button is visible. By default the cancel button is visible when in edit mode.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editDefault	Boolean	false	If true, the Edit button will be the default button which can be invoked by Enter key.
editLabel	Expression (String)		Alternative label for the edit button
editShortcut	String	E	Keyboard shortcut character for edit button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
editVisible	Expression (Boolean)		Boolean expression specifying whether the edit button is visible. By default the edit button is visible when not in edit mode.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
pickValue	Expression (context-dependent)		The value returned from this location when update is clicked
showUpdateConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
updateConfirmMessage	Expression (String)		Confirmation message to show when update is clicked
updateDefault	Boolean	false	If true, the Update button will be the default button which can be invoked by Enter key.
updateLabel	Expression (String)		Alternative label for the update button
updateShortcut	String	U	Keyboard shortcut character for update button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
updateVisible	Expression (Boolean)		Boolean expression specifying whether the update button is visible. By default the update button is visible when in edit mode.

EmbeddedInput

top

A input that renders content from `appUrl` and displayed in iframe, this element can communicate to Guidewire server with actionHandler and updateHandler.

Child elements:

LayoutConfig EmbeddedWidgetRef

Attribute:	Type:	Default:	Description:
actionHandler	Expression (gw.api.web.embedded.EmbeddedWidgetActionHandler)		A handler object whose 'action' method will be invoked if the embedded widget's client side calls the gw.api.submitAction function, passing in the JSON object as arguments. The JSON from the client will be given as the argument to the 'action' method. The 'action' method is called as part of a normal Pebbles request; all input values are sent to the server, variables are refreshed (if marked as 'recalculateOnRefresh') and the UI is re-rendered. The 'action' method can do anything a normal menu or button action can do, including navigating to other pages.
appOrigin	Expression (String)		All communication with the embedded frame checks the frame origin (see documentation on Window.postMessage and the 'message' event). By default the frame origin is just the first part of the appUrl, but it can be overridden by providing an explicit appOrigin. This can be useful if the initial appUrl redirects to another application URL
appUrl	Expression (String)		The URL that will be used to load the embedded widget iframe; the values provided by the contextProviderwill be passed in a form (for POST) or as URL parameters (for GET)
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
boldLabel	Boolean	false	If true then the label is displayed in bold text.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
contextProvider	Expression (gw.api.json.JsonObject)		Creates JSON that will be sent along with the initial request to the Embedded Application's configured endpoint
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
requestType	EmbeddedWidgetRequestType		Request type to external service; options include "GET" and "POST". See the EmbeddedWidgetRequestType enumeration.
updateHandler	Expression (gw.api.web.embedded.EmbeddedWidgetUpdateHandler)		A handler object whose 'update' method will be invoked if the embedded widget's client side calls the gw.api.callServer function, passing in a JSON object as arguments. The JSON from the client will be given as the argument to the 'update' method and the JSON returned by the 'update' method will be returned to the client. The 'update' method is not called as part of a normal Pebbles request; no input values will be saved or variables refreshed. Any client side state that is needed by the 'update' method must be explicitly passed in the JSON. The 'update' method must not attempt to navigate elsewhere, it should just return updated data to the client
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

EmbeddedPanel

top

A panel that renders content from `appUrl` and displayed in iframe, this element can communicate to Guidewire server with actionHandler and updateHandler.

Child elements:

EmbeddedWidgetRef

Attribute:	Type:	Default:	Description:
actionHandler	Expression (gw.api.web.embedded.EmbeddedWidgetActionHandler)		A handler object whose 'action' method will be invoked if the embedded widget's client side calls the gw.api.submitAction function, passing in the JSON object as arguments. The JSON from the client will be given as the argument to the 'action' method. The 'action' method is called as part of a normal Pebbles request; all input values are sent to the server, variables are refreshed (if marked as 'recalculateOnRefresh') and the UI is re-rendered. The 'action' method can do anything a normal menu or button action can do, including navigating to other pages.
appOrigin	Expression (String)		All communication with the embedded frame checks the frame origin (see documentation on Window.postMessage and the 'message' event). By default the frame origin is just the first part of the appUrl, but it can be overridden by providing an explicit appOrigin. This can be useful if the initial appUrl redirects to another application URL
appUrl	Expression (String)		The URL that will be used to load the embedded widget iframe; the values provided by the contextProviderwill be passed in a form (for POST) or as URL parameters (for GET)
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	true	If true, the EmbeddedPanel will have a border around it.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
contextProvider	Expression (gw.api.json.JsonObject)		Creates JSON that will be sent along with the initial request to the Embedded Application's configured endpoint
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
requestType	EmbeddedWidgetRequestType		Request type to external service; options include "GET" and "POST". See the EmbeddedWidgetRequestType enumeration.
updateHandler	Expression (gw.api.web.embedded.EmbeddedWidgetUpdateHandler)		A handler object whose 'update' method will be invoked if the embedded widget's client side calls the gw.api.callServer function, passing in a JSON object as arguments. The JSON from the client will be given as the argument to the 'update' method and the JSON returned by the 'update' method will be returned to the client. The 'update' method is not called as part of a normal Pebbles request; no input values will be saved or variables refreshed. Any client side state that is needed by the 'update' method must be explicitly passed in the JSON. The 'update' method must not attempt to navigate elsewhere, it should just return updated data to the client
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

EmbeddedWidgetRef

top

Specifies the widget needed by the embedded section.

Attribute:	Type:	Default:	Description:
name	String		The name will be used for external service
widget	String		The pcf id of the widget

EmbeddedWidgetRequestType

top

Request Type for Embedded Widgets

Value:	Description:
POST	POST request used to submit an form to the external resource
GET	GET requests to get the external resource.

EmptyCell

top

An empty cell without a value, generally used to provide proper column alignment in heterogeneous list views

Child elements:

Reflect ColumnFooter

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

EntryPoint

top

Maps from a URI that the browser can enter to a starting Location

Child elements:

EntryPointParameter

Attribute:	Type:	Default:	Description:
authenticationRequired	Boolean	true	If true, the user must be logged in to enter through this point. If the user is not already logged in, a login page will appear before the entry point's location (unless some kind of automatic authentication occurs). Be very careful about setting this to false.
clearSession	Boolean	false	If true, clears the user's server session when they enter this entry point
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
failurePage	Location reference		Normally not specified, and a default error page with detailed error messages will be displayed when for some reason the EntryPoint could not navigate to the target Location. If a page ID is specified, that page will be displayed instead of the default error page in case of error. No runtime error message will be passed to the custom page, and only static content of that page will be displayed.
id	String		ID of this EntryPoint. Must be unique among all EntryPoints.
location	Location reference		The ID of the Page, Forward, or Wizard to go to upon navigating to this EntryPoint. Note that if you want the entry point to do some complex logic, it's best to use a Forward.

EntryPointParameter

top

An HTTP parameter that gets mapped to a Location parameter

Attribute:	Type:	Default:	Description:
conversionExpression	Expression (Object)		Gosu expression used to convert a URL parameter to the value passed to the location Parameter
desc	String		Use this to add your own comments to the entry point param. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
locationParam	String		The name of the argument on the target location's entry point that this parameter will set
optional	Boolean	false	If true, the parameter does not need to be specified
type	Type reference		The type to cast the incoming parameter into, such as "String" or "Integer"
urlParam	String		The parameter passed in through the URL; for example if the param is Activity and the entry point URI is ActivityDetail, you would pass Activity 3 as ActivityDetail.do?Activity=3

ExitPoint

top

Special Location for leaving the UI and redirecting somewhere else.

Child elements:

LocationEntryPoint ExitPointParameter

Attribute:	Type:	Default:	Description:
height	Integer	0	Height in pixels of the popup window, if popup=true
id	String		ID of this ExitPoint. Must be unique among all ExitPoints.
isMultiClusterNav	Boolean	false	If true, indicates that this ExitPoint is navigating to another Cluster within the same Application.
logout	Boolean	false	If true, logs the user out of the application when they go through the ExitPoint
method	HttpMethod		HTTP method to use for this ExitPoint. If omitted, defaults to GET
popup	Boolean	false	If true, opens the exit URL in a new window instead of the current one
target	String		An optional name of the popup window. Only applicable when "popup" is true. If not specified, a new window will be opened each time this exit point is invoked.
url	String		The URL to redirect the user to, such as "http://www.guidewire.com"
width	Integer	0	width in pixels of the popup window, if popup=true

ExitPointParameter

top

An parameter to the exit point that is mapped to a URL parameter. The exact opposite of EntryPointParameter.

Attribute:	Type:	Default:	Description:
defaultValue	String		The default value to use if no symbol has been provided for this param (assuming required=false; otherwise an exception will be thrown). A Gosu Expression
desc	String		Use this to add your own comments to the exit point param. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
locationParam	String		The name of the parameter. Any link to the exit point must have a symbol defined with name equal to locationParam and of type "type" (unless required="false").
type	Type reference		The type of symbol that must be passed as "locationParam"
urlParam	String		Param name as appears in the url. If not specified assumed to be the same as "locationParam"

ExposeIterator

top

Specifies that an iterator of a given name and type is exposed by the parent widget. This iterator can be accessed by other widgets in other pcf pages.

Attribute:	Type:	Default:	Description:
applicable	Boolean	true	Indicates if the widget is actually applicable in the current context. This is provided for modal panels that do not expose all of the widgets that are available in its sibling modes.
flags	Flag names		A comma separated list of the flags for the iterator
name	String		The symbol to expose the widget as. If the widget is defined on this page, this value will default to the widget name. If the widget is in a ref, this value will default to the name exposed by the ref.
valueType	Type reference		The valueType of the widget symbol, such as "String" or "Policy"
widget	Iterator name		The name of the iterator

Expose

top

Specifies that a symbol of a given name is exposed by the parent widget. This widget can be accessed by other widgets in other pcf pages.

Attribute:	Type:	Default:	Description:
applicable	Boolean	true	Indicates if the widget is actually applicable in the current context. This is provided for modal panels that do not expose all of the widgets that are available in its sibling modes.
name	String		The symbol to expose the widget as. If the widget is defined on this page, this value will default to the widget name. If the widget is in a ref, this value will default to the name exposed by the ref.
widget	Widget id		The name of widget

ExposeRowTree

top

Specifies that a row tree of a given name and type is exposed by the parent widget. This rowTree can be accessed by other widgets in other pcf pages.

Attribute:	Type:	Default:	Description:
applicable	Boolean	true	Indicates if the widget is actually applicable in the current context. This is provided for modal panels that do not expose all of the widgets that are available in its sibling modes.
flags	Flag names		A comma separated list of the flags for the row tree
name	String		The symbol to expose the widget as. If the widget is defined on this page, this value will default to the widget name. If the widget is in a ref, this value will default to the name exposed by the ref.
valueType	Type reference		The content type of the row tree, such as "String" or "Policy". This value is required if the rowtree has checkboxes.
widget	Iterator name		The name of the row tree

FileCell

top

A cell for selecting files

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
buttonText	Expression (String)	DisplayKey.get("Web.Document.FileValue.Browse")	The text displayed in the file input button
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
dropzoneWidgets	Widget ids		A comma separated list of widgets that are drag and drop zones for this file input.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
multiple	Boolean	false	If set to true, the file input may be used to select multiple files
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueDisplayed	Expression (Boolean)	true	If set to true, the name(s) of the selected file(s) is/are displayed next to the file input button
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

FileInput

top

An input for selecting files

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
buttonText	Expression (String)	DisplayKey.get("Web.Document.FileValue.Browse")	The text displayed in the file input button
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
dropzoneWidgets	Widget ids		A comma separated list of widgets that are drag and drop zones for this file input.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
multiple	Boolean	false	If set to true, the file input may be used to select multiple files
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueDisplayed	Expression (Boolean)	true	If set to true, the name(s) of the selected file(s) is/are displayed next to the file input button
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueWidgetType	String	Text	The type of value widget to create for this input, such as Text or TypeKey.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

FormatCell

top

A ListView cell that renders children widgets. By default, Stacked is true, thereby rendering its children in a single column.

Child elements:

Reflect ColumnFooter TextInputBase ContentInput InputIterator

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
stacked	Expression (Boolean)	true	If true, the contents of the Widget will be stacked vertically.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

FormatType

top

Input format types

Value:	Description:
general	No special formatting applied
currency	Formatted to look like an amount of money
email	Formatted to look like an email address, including a "mailto:" link
percentagePoints	Formatted to look like a percentage
exactNumber	Formatted as a number with full precision (no rounding)
phoneNumber	Formatted as a phone number
integerNumber	Formatted as a number of whole units, with grouping separators

ForwardCondition

top

Forwards to a location if the given condition is satisfied

Attribute:	Type:	Default:	Description:
action	Statement		The action that is performed when the Forward is entered, if "condition" evaluates to true. See ActionBase for details.
condition	Expression (Boolean)	true	A Gosu expression evaluating to a Boolean. The first ForwardCondition which evalutes to true has its action run

Forward

top

A Location that automatically redirects to some other Location

Child elements:

LocationEntryPoint Variable ForwardCondition Code

Attribute:	Type:	Default:	Description:
action	Statement		The action that is performed when the Forward is entered. See ActionBase for details.
allowGoOrPush	Boolean	false	A normal Forward can safely redirect to either go calls or push calls but not both. If this flag is set the Forward can redirect to either a go or a push. A Forward with allowGoOrPush true must be pushed and it will pop itself automatically before executing the final destination expression
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
id	String		ID of this Location. Must be unique among all Locations.
onBeforeForward	Statement		An expression that will be executed prior to the forward.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.

GroupCell

top

A Cell that includes a drop-down list of groups, and a menu containing Select Group and Search Group items. The locations to which those items navigate are specified by the searchLocation and selectionLocation attributes.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)	pcf.GroupSearchPopup.push()	The location of the group search item as a Gosu expression of the form "[location name].push()"
selectLocation	Expression (pcf.api.Location)	pcf.OrganizationGroupTreePopup.push()	The location of the group select items as a Gosu expression of the form "[location name].push()"
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)	gw.api.admin.BaseAdminUtil.getGroupsForCurrentUser()	A list of possible values as a Gosu
valueType	Type reference	entity.Group	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

GroupInput

top

An Input that includes a drop-down list of groups, and a menu containing Select Group and Search Group items. The locations to which those items navigate are specified by the searchLocation and selectionLocation attributes.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)	pcf.GroupSearchPopup.push()	The location of the group search item as a Gosu expression of the form "[location name].push()"
selectLocation	Expression (pcf.api.Location)	pcf.OrganizationGroupTreePopup.push()	The location of the group select items as a Gosu expression of the form "[location name].push()"
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)	gw.api.admin.BaseAdminUtil.getGroupsForCurrentUser()	A list of possible values as a Gosu
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.Group	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

HeadingLevel

top

Value:	Description:
1
2
3

HiddenInput

top

An input which is present client-side but never displayed to nor editable by the user. Consider using a Variable instead if the value doesn't need to be present on the client.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

HiddenLink

top

An invisible link that can only be invoked by JavaScript or a keyboard shortcut

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

HttpMethod

top

Value:	Description:
GET
POST

IconTypeEnum

top

Different types of Icons

Value:	Description:
customIconClass	The icon field will be added as a CSS class to the gw-icon div. customIconClass with a blank icon field will still cause an empty gw-icon div to be used.
pngFileName	Legacy. The Icon field represents a PNG Image File name
svgFileName	The Icon field represents an SVG File Name
gwFontGlyph	The Icon field represents the name of a glyph in the default Guidewire font based icon library.
customerFontGlyph	The Icon field represents the name of a glyph in the customer custom font based icon library.

ImageActionCell

top

A Cell for displaying an Image Action Widget.

Child elements:

Reflect ColumnFooter

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
altText	Expression (String)		The alt attribute for the image element. If not specified, will be set to the file name.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		The style for the optional badge label.
badgeText	Expression (String)		If present, then the text will appear as a label badge on top of the image.
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
imageFit	ObjectFit	contain	The value for the CSS property object-fit, which describes how the image should be scaled or cropped if its defined dimensions differ from its file dimensions.
imageStyle	ImageStyle	Rounded	Additional styling options for the visual appearance of the image.
imageURL	Expression (String)		The Universal Resource Locator string for the image file.
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

ImageAction

top

A Widget for displaying an optionally clickable image file.

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
altText	Expression (String)		The alt attribute for the image element. If not specified, will be set to the file name.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		The style for the optional badge label.
badgeText	Expression (String)		If present, then the text will appear as a label badge on top of the image.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
imageFit	ObjectFit	contain	The value for the CSS property object-fit, which describes how the image should be scaled or cropped if its defined dimensions differ from its file dimensions.
imageStyle	ImageStyle	Rounded	Additional styling options for the visual appearance of the image.
imageURL	Expression (String)		The Universal Resource Locator string for the image file.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ImageCell

top

A Cell for displaying an Image Widget.

Child elements:

Reflect ColumnFooter

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
altText	Expression (String)		The alt attribute for the image element. If not specified, will be set to the file name.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		The style for the optional badge label.
badgeText	Expression (String)		If present, then the text will appear as a label badge on top of the image.
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
imageFit	ObjectFit	contain	The value for the CSS property object-fit, which describes how the image should be scaled or cropped if its defined dimensions differ from its file dimensions.
imageStyle	ImageStyle	Rounded	Additional styling options for the visual appearance of the image.
imageURL	Expression (String)		The Universal Resource Locator string for the image file.
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
thumbURL	Expression (String)		If present, then the Image Widget will display the thumb URL as its primary image. And will display the image from the URL property in a modal pop-up when clicked.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

ImageMediaObject

top

A Widget for displaying an image file from a SimpleMediaObject. Optionally can display a thumbnail and show the full-sized image in a modal when clicked.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mediaImageObject	Expression (gw.api.web.media.MediaImageWithThumbObject)		A gosu expression that returns a SimpleMediaObject.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

Image

top

A Widget for displaying an image file. Optionally can display a thumbnail and show the full-sized image in a modal when clicked.

Attribute:	Type:	Default:	Description:
altText	Expression (String)		The alt attribute for the image element. If not specified, will be set to the file name.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
badgeStyle	Expression (gw.api.web.BadgeStylesEnum)		The style for the optional badge label.
badgeText	Expression (String)		If present, then the text will appear as a label badge on top of the image.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
imageFit	ObjectFit	contain	The value for the CSS property object-fit, which describes how the image should be scaled or cropped if its defined dimensions differ from its file dimensions.
imageStyle	ImageStyle	Rounded	Additional styling options for the visual appearance of the image.
imageURL	Expression (String)		The Universal Resource Locator string for the image file.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
thumbURL	Expression (String)		If present, then the Image Widget will display the thumb URL as its primary image. And will display the image from the URL property in a modal pop-up when clicked.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ImageStyle

top

Value:	Description:
None	The image will have no additional style.
WhiteMatte	The image will have a thick white matte section.
BlackMatte	The image will have a thick black matte section.
Rounded	The image will have rounded corners.
RoundedAndRaised	The image will have rounded corners and a drop shadow.
Custom	The image will have a custom css class requiring the theme to have a custom SASS class added to style the image].

IndustryCodeCell

top

A ListView cell specialized for ClassCode fields

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
domain	Expression (typekey.IndustryCodeType)
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
previousCode	Expression (String)	null	The previous selected industry code, it will be allowed to use within the same term even if it's expired.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
referenceDate	Expression (java.util.Date)	null	The reference date used to check for expiration.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.IndustryCode	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

IndustryCodeInput

top

Version of Input specialized for IndustryCodeInput fields

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
domain	Expression (typekey.IndustryCodeType)
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
previousCode	Expression (String)	null	The previous selected industry code, it will be allowed to use within the same term even if it's expired.
referenceDate	Expression (java.util.Date)	null	The reference date used to check for expiration.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.IndustryCode	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

InfoBarElement

top

A single element in InfoBar, where the Value is displayed in Bold.

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
nullString	String		String to be displayed if the value is null. Defaults to an empty string.
tooltip	Expression (String)		Tooltip for this widget
value	Expression (Object)		The value of the element, displayed in bold.
valueIcons	Expression (Object)		An optional reference to one or multiple image files. If specified, the image(s) will be displayed in front of the value.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

InfoBar

top

A single line just below the TabBar for displaying arbitrary page info

Child elements:

Require InfoBarElement Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

InputColumn

top

A column whose content is formatted as a series of label / value pairs.

Child elements:

AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hasBorders	Boolean	false	Deprecated. Use border.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
labelWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Override the SASS variable for InputColumn fallback-label-size to change label sizes globally.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
refreshOnProgressComplete	Expression (Object)		Only meaningful when this widget contains a Progress widget. Specifies an entity to refresh when the Progress widget completes its operation, at which point this widget will re-render itself.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

InputColumnSubGroup

top

Visually groups a set of Inputs together, with an optional sub-header label. The sub-header label can be set to visually match Label styling, or to match the standard Input labels.

Child elements:

AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
label	Expression (Object)		Optional label for this sub group
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
useStandardInputLabelStyle	Boolean	false	If true, the Label for the sub group will have the same styling as a standard Input Label set to 'Label Above'. If false, the styling will use the Label Widget styling.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides this widget

InputDivider

top

A horizontal line for separating DetailView items

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

InputFooterSection

top

Child elements:

AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
labelWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Override the SASS variable for InputColumn fallback-label-size to change label sizes globally.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
refreshOnProgressComplete	Expression (Object)		Only meaningful when this widget contains a Progress widget. Specifies an entity to refresh when the Progress widget completes its operation, at which point this widget will re-render itself.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

InputGroup

top

Groups a set of Inputs together and provides a group label and allows the user show or hide content under this group.

Child elements:

AbstractInput InputSet PostOnChange

Attribute:	Type:	Default:	Description:
allowToggle	Expression (Boolean)		An optional Boolean expression, if returns false, the checkbox for the user to toggle visibility of child widgets will be disabled. Default to true.
alwaysShowCheckbox	Boolean	false	If true, then the checkbox will always be visible, regardless of being editable or available or disabled.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
childrenVisible	Expression (Boolean)		A Boolean expression which indicates if child widgets under this group are visible, and whether the checkbox is checked. The expression must be writeable, unless the "onToggle" attribute is specified.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label for this group
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
onToggle	Statement		If specified, this expression will be executed (instead of setting "childrenVisible") when the user toggles the checkbox. The current state of the checkbox is exposed as "VALUE". Executing this expression MUST result in the value of "childrenVisible" to match the "VALUE" passed in. This attribute is normally NOT specified.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the user checks or unchecks this group.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

InputHeaderSection

top

Child elements:

AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
labelWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Override the SASS variable for InputColumn fallback-label-size to change label sizes globally.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
refreshOnProgressComplete	Expression (Object)		Only meaningful when this widget contains a Progress widget. Specifies an entity to refresh when the Progress widget completes its operation, at which point this widget will re-render itself.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

InputIterator

top

An iterator for DetailView content.

Child elements:

IteratorSort AbstractInput InputSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoAdd	Expression (Boolean)		An optional Boolean Gosu expression, if evaluated to true, add numEntriesToAdd elements to this iterator when entering the page, if the page is in edit mode upon enter. Normally not set, unless the iterator has less entries than required; otherwise, the user may have to manually remove unwanted entries that are automatically added.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		An optional Gosu expression used to convert a picked value into a value that can be added to the iterator. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
forceRefreshDespiteChangedEntries	Boolean	false	If true, the iterator will refresh its entries even if they have changed. This has risks. Refreshing from an IQueryBeanResult value will ignore newly added or removed entries. Changed or newly added entries may be reordered. User input that cannot be written to the underlying data (such as malformed date strings) may be lost. Use with care. Safest on list or array iterators that contain only simple inputs such as checkboxes or dropdowns
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
numEntriesToAdd	Integer		An optional attribute, if set, overrides number of entries to add when the add button is pushed. Default to 1. Normally not set. If set to a value greater than 1, any entry that is not modified by the user after it's added will be removed before commit the page. It's a risk of potential data loss. USE WITH CAUTION.
pickLocation	Statement		Specifies the picker popup to use when adding new elements to the iterator, as a Gosu statement of the format "[popup name].push(...)"
toAdd	Statement		The Gosu expression that is evaluated to add a new value to the list. The value is exposed using the name specified by "elementName". An example would be "Foo.addToBars(bar)". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both. If the entries are not entities, toCreateAndAdd must be used instead of toAdd.
toCreateAndAdd	Expression (context-dependent)		The Gosu expression that is evaluated to create a new value and add it to the list. An example would be "Foo.addToBars(Foo.createNewBar())". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both.
toRemove	Statement		The Gosu expression that is evaluated to remove a value from the Iterator. The value is exposed using the name specified by "elementName". Must be defined for the user to be able to remove values from the iterator.
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this iterator to be used when it has validation issues.
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.

InputRestrictionType

top

Enumerates the options for the type of characters allowed by the input

Value:	Description:
defaultForType	Allow the input to determine its own inputRestrictionType, based on other sensible properties like formatType.
all	All characters allowed. Alphabetic. Numeric. Special.
numerals	Only numeric characters allowed. 0 through 9. Commonly used for values like an account number or a social security number. Also frequently used with an input mask to provide things like hyphen separators: ###-##-####
integer	Same as numerals, but with the addition of the minus sign (-). Will also trigger comma separators being added during input mode. Commonly used for unit based entry that could be negative. Like number of accounts gained or lost.
phone	Same as integer, but with the addition of plus (+), space ( ) and open and closed parenthesis.
decimal	Only numeric characters 0 through 9 and period (.) and comma (,) and minus (-)
alphabeticAToZ	Only upper and lowercase A through Z characters allowed.
alphabeticAToZNumeric	Combination of alphabeticAToZ and numeric.
alphabeticAToZNameChars	Same as alphabeticAToZ, but with additional name characters like whitespace ( ), period (.), hyphen (-) and apostrophe (').
alphabeticGlobal	Only characters allowed by the unicode escape property \p{L}. This essentially allows any standard word in any language supported by the Unicode standard.
alphabeticGlobalNumeric	Combination of alphabeticGlobal and numeric.
alphabeticGlobalNameChars	Same as alphabeticGlobal, but with additional name characters like space ( ), period (.), hyphen (-) and apostrophe (').
customPerCharacterRegex1	Exists only to allow the customer to add custom per character validation. Either by overriding this option via the gwClientValidation.userRestrictionTypeCustomerOverrides map. Or by the server configuration option CustomPerCharacterRegex1
customPerCharacterRegex2	Same purpose as customPerCharacterRegex1.

InputSet

top

A reusable set of Inputs

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget AbstractInput InputSet Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

InputSetRef

top

Includes an InputSet by reference.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		The ID of the InputSet to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

IteratorButtons

top

A set of pre-included toolbar buttons for iterator control, including "add" and "remove". The "add" button lets the iterator to add new entries using its default behavior. If you want to override the default add behavior of the iterator, use <AddButton> element instead.

Attribute:	Type:	Default:	Description:
addConfirmMessage	Expression (String)		Confirmation message to show before performing the add action
addLabel	Expression (String)		Alternative label for the add button
addShortcut	String	A	Keyboard shortcut character for add button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
addVisible	Expression (Boolean)		Boolean expression specifying whether the add button is visible. By default the add button is visible when the location is in edit mode and the Iterator has "toAdd", "toCreateAndAdd" , or "pickLocation" defined.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	true	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
removeConfirmMessage	Expression (String)		Confirmation message to show before performing the remove action
removeFlags	String		The flags to determine availability of the remove button. See the ToolbarButton "flags" attribute for syntax. By default, the remove button is available when at least one row in the list is checked.
removeLabel	Expression (String)		Alternative label for the remove button
removeShortcut	String	R	Keyboard shortcut character for remove button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
removeVisible	Expression (Boolean)		Boolean expression specifying whether the remove button is visible. By default the remove button is visible when the Iterator has "toRemove" defined.
showAddConfirmMessage	Expression (Boolean)	true	Expression which determines whether or not the add confirmation message should be shown
showRemoveConfirmMessage	Expression (Boolean)	true	Expression which determines whether or not the remove confirmation message should be shown

IteratorSort

top

Provides an expression used to sort the enclosing iterator

Attribute:	Type:	Default:	Description:
sortBy	Expression (Object)		Gosu expression specifying the value by which the nearest Iterator will be sorted.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer		The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"

JobWizard

top

===== PolicyCenter-specific wizard PCF elements. ===== A PC specific wizard for managing jobs that do not require multi-quote capability

Child elements:

LocationEntryPoint Variable AbstractWizardStepsRef AbstractWizardStepsDef Code

Attribute:	Type:	Default:	Description:
acceleratedMenuActions	Shared section reference		The ID of the AcceleratedMenuActions content for this location group. It will be inherited by all descendent Locations of this group by default. Normally not used, but use MenuActions instead.
afterCancel	Statement		Gosu expression to run after the Wizard is canceled. See ActionBase for kinds of available actions
afterFinish	Statement		Gosu expression to run after the user gets all the way through and finishes the Wizard.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the Wizard is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the wizard state is persisted into database.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
cancelWarning	Expression (String)		Gosu expression that returns a message to display in a confirmation dialog when the user attempts to cancel this wizard
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
id	String		ID of this Location. Must be unique among all Locations.
independentStepsTitle	Expression (String)		The optional title for menu links of independent steps.
independentStepsTitleIcon	Expression (String)		The optional title icon for menu links of independent steps.
independentStepsTitleIconType	IconTypeEnum		An enumeration of icon types that determine what the 'independentStepsTitleIcon' property on the widget is referring to.
infoBar	Shared section reference		ID of the InfoBar content for this location (just below the TabBar and above the main content)
initialStep	Expression (String)		The id of the step the wizard should go to when it is first entered.
isDraftOnEnter	Expression (Boolean)		A boolean expression which, if true, means the wizard started from a previously saved draft, in which case the wizard does not appear as unsaved work on enter.
jobType	Type reference		The type of job processed in this wizard. This must be a subtype of JoXMLNodeMetadataBuilder.
menuActions	Shared section reference		ID of the optional MenuActions content for this location (in the bottom of the left menu)
menuLinks	Shared section reference		Normally NOT specified, in which case default MenuLinks (in the left menu) are generated based on steps of this wizard. If an empty string is specified, this wizard will have no MenuLinks of its own, and will inherit MenuLinks from its ancestor location group (if any).
menuTree	Shared section reference		ID of the optional MenuTree content for this location (in the left menu). This should only be used if the wizard is also overriding the menuLinks attribute
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
onResume	Statement		A Gosu expression to run when this location is resumed from the autosave cache.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startInEditMode	Expression (Boolean)	true	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it. Default to true for Wizard.
subtitle	Expression (String)		The optional sub title for this wizard. If specified, it will be displayed in the left nav bar above links to wizard steps.
tabBar	Shared section reference	TabBar()	ID of the TabBar content for this location group. Normally not specified since "TabBar()" is the default.
title	Expression (Object)		The optional title for this wizard. If not specified, only the current step title shows in the top title bar. If specified, this wizard title and the current step title will both show in the title bar.

JobWizardStep

top

Defines one step in a JobWizard.

Child elements:

NextCondition SkipButton

Attribute:	Type:	Default:	Description:
allowFinish	Expression (Boolean)		Gosu expression indicating whether or not the finish button is available. If not specified, then the finish button will be available if this is the last step in the wizard.
allowNext	Expression (Boolean)		Gosu expression indicating whether or not the next button is available. If not specified, then the next button will be available unless this is the last step in the wizard.
available	Expression (Boolean)	true	A boolean expression which, if false, grays the step out and won't let the user visit it (as opposed to visible/canVisit, which hide the step completely)
beforeSave	Statement		Gosu expression to execute before save this step. Only applicable when "save" returns true.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this Step. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". And the corresponding validation issue is exposed as "ISSUE"
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		The reference ID of the step, which must be unique among all locations. This ID is used for a lot of purposes; most importantly it is what you refer to in the "go" action
independent	Boolean	false	If true, the step is displayed at the bottom of the wizard, and is separated from ordinary wizard navigation; in particular, it is not affected by the high water mark.
label	Expression (String)		The label for this step in the wizard menu links. If unspecified, the "title" attribute is used as the default.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the screen will be loaded whose "mode" matches the evaluated "mode" of this element. If no screen is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
onChange	Statement		A Gosu expression which is executed every time the values in the JobWizardStep's screen changes.
onEnter	Statement		Gosu expression to execute when entering this step every time.
onExit	Statement		Gosu expression to run when leaving this step to move forward in the wizard or when finishing on this step.
onFirstEnter	Statement		Gosu expression to execute when entering this step for the first time.
refreshStepsOnExit	Boolean	false	If true, refreshes the steps in the wizard when leaving this step. Should only be set to true on steps that allow the editing of some value that could affect a WizardStepIterator defined in this wizard
save	Expression (Boolean)	false	If true, a draft will be saved whenever we exit this step
screen	Shared section reference		The ID of the Screen for this step.
shortcut	String		Optional Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. If specified, this will be used for the MenuLink generated for this WizardStep.
showNextIfLastStep	Boolean	false	If true, the next button will always be shown, regardless of whether or not the wizard thinks it has more steps.
title	Expression (String)		The title for this step
validateOnFirstEnter	Expression (boolean)		A Gosu expression which is evaluated to determine whether or not validation is performed the first time this step is entered.
visible	Expression (Boolean)	true	A boolean expression which indicates if this Step is visible at all in the Wizard

Label

top

A label for marking a section of the DetailView

Child elements:

LayoutConfig

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
boldLabel	Boolean	true	If true, the font for this label will be bold. Defaults to true
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (String)		Text to display in the label widget.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides this label

LabelOrientation

top

Value:	Description:
Horizontal
Vertical
Down45
Up45

LayoutConfig

top

Optional layout configuration for inputs.

Attribute:	Type:	Default:	Description:
colspan	Expression (java.lang.Integer)		Gosu expression that defined the column span for the field, it only apply to table layout and the expression should evaluate to an integer
tdClass	Expression (String)		Custom CSS style classes applied to the containing cell in a Table Layout. It should evaluate to one or more style classnames.

Layout

top

Optional layout configuration for children of this element. If Table type is enabled, then children will be laid out based on the number of columns specified.

Attribute:	Type:	Default:	Description:
border	Boolean	false	If true, the child elements will have a border around them. Purely a visual effect.
columns	Expression (java.lang.Double)		Gosu expression that defines the total number of columns to create for table layout.
type	LayoutType		Layout type; options include "table".

LayoutType

top

Layout format types

Value:	Description:
table	Table formatting applied

LegendPosition

top

Supported legend positions for charts.

Value:	Description:
top
bottom
right
left

LinkCell

top

A ListView cell containing arbitrary content, such as links.

Child elements:

Reflect ColumnFooter AbstractLink

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
stacked	Expression (Boolean)	false	If true, the contents of the Widget will be stacked vertically.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	false	If true, allows cell content to wrap. Defaults to false for link cells.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

LinkIterator

top

Generates Link elements based on a list of values.

Child elements:

IteratorSort AbstractLink

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.

Link

top

Generates a hyperlink that can perform some action when the user clicks on it

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
argInitialValue	Expression (Object)		The optional initial value for the action argument. Only meaningful, when "argType" is specified.
argLabel	Expression (String)		The optional label for the action argument. Only meaningful, when "argType" is specified.
argOptionLabel	Expression (Object)		Optional Gosu expression to determine the label displayed for each element in the arg range. If not set, default to the element's string representation. The element value is exposed as "VALUE".
argRange	Expression (Object)		Gosu expression defining the range of possible arg values for this action. Should evaluate to a list that matches the "argType"
argType	String		The type of the argument for this action.If set, the widget will allow the user to enter an argument value of this type before invoke the action.Supported types: String, Number and java.util.Date.The argument value is exposed to the "action" attribute as "ArgValue".
argWidth	Positive integer		Optional pixel width for the dropdown control of the action argument. Only applicable when "argRange" is specified.Usually you get best results by leaving this unspecified. You can set this attribute when some options in the dropdown range are too long and you need to reduce the display width of the dropdown control.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
performActionOnArgChange	Boolean	false	The optional flag, if true, the action will be performed as soon as the arg value ischanged and no action button will be rendered
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
recalculateArgOnRefresh	Boolean	false	The optional boolean flag, if set, the value of the action argument will be reset by calculating the argInitialValue expression, when the page is rerendered from the server. Default to false.
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
styleClass	LinkStyleClass		CSS style class for the link; for instance, "miniButton" makes the link appear as a small button
tooltip	Expression (String)		An expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

LinkStyleClass

top

Style class of a widget

Value:	Description:
none	none
miniButton	Makes a link look like a small button
bigButton	Makes a link look like a normal button
stretch	!!Deprecated.
bold	Makes the text bold for a Link element
archived	!!Deprecated.
noSpaceLink	Link with no spacing before and after

ListDetailPanel

top

A special panel for displaying a ListView, followed by a CardView whose contents can depend on the element selected in the ListView.

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget ChildOfPanel AbstractPanelDef Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
lockWhileEditing	Boolean	false	If true, then the user won't be allowed to change the selection while the current selection is being edited.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
selectionName	String		Name of the special "selection" symbol representing the selected value from the list. The card set typically refers to this symbol to show information about it.
selectionOnEnter	Expression (Object)		If this expression evaluates to anything other than null, the list-detail panel will attempt to select the result when this page is entered. Typically this will be set to a variable which is (optionally) passed in to this page.
selectionType	Type reference		Type of the selection symbol, usually the same as the type of element rendered by rows in the ListView

ListViewInput

top

Includes an entire ListView as an input, and supplies it with an optional toolbar.

Child elements:

Toolbar ListViewPanel

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		ID of the ListView to include by reference (should only be used if you are not adding the def as a direct child of this element).
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
disableUserCustomization	Boolean	true	If true, prevents the child ListViewPanel from enabling User customization.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (String)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the ListView, allowing the ListView to expand left into the column of labels
labelStyleClass	String		Custom extension CSS style class to apply to the label.
listViewStyle	ListViewStyleEnum		Provides an override for the listViewStyle property on the child ListViewPanel.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mode	Expression (Object)		If you are including the ListView by reference and you define a "mode" expression, then "mode" is evaluated and its result is converted to a String; the Def will be loaded whose "mode" matches the evaluated "mode" of this element. If no Def is found with a matching "mode", then the Def with mode="default" is used; if there is no default a runtime exception is thrown
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as error and the record will not be committed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ListViewPanel

top

A panel whose content is formatted as a two-dimensional table

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget AbstractRow Code

Attribute:	Type:	Default:	Description:
alternateEntryStyle	Boolean	true	If true and the theme permits it, odd numbered rows will have a different background color than even rows. Defaults to true.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
bottomPaging	Boolean	false	If true, and the ListView has paging controls, then the paging controls will also be placed below the ListView's table.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
disableUserCustomization	Boolean	false	If true, the ListView columns can NOT be hidden, reordered, or grouped.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
emptyTableLabel	Expression (String)		An optional expression specifying the text to display in a table if no iterated rows are present. If not specified, defaults to the platform display key Java.ListView.DefaultEmptyTableLabel
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
listViewStyle	ListViewStyleEnum		An enumeration of style options for the ListView. These will dramatically change complex aspects of the ListView's appearance.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
stretch	Boolean	false	If true, the LV will fill its container, allowing configured cells to `Grow` to fill the extra space.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as error and the record will not be committed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ListViewStyleEnum

top

Different styles for ListViews

Value:	Description:
minimalStyle	The ListView has a minimal style.
rowListStyle	The ListView is styled to appear as a list of rows.
gridStyle	The ListView is styled as a grid of cells.

ListViewTile

top

A two-dimensional table for a Tile

Child elements:

Require Variable TileActions RowIterator

Attribute:	Type:	Default:	Description:
alternateEntryStyle	Boolean	true	If true and the theme permits it, odd numbered rows will have a different background color than even rows. Defaults to true.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
hideViewMoreIfShortList	Boolean	false	Indicates, if there is less rows than 5, tile footer will be automatically hidden.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
listViewStyle	ListViewStyleEnum	minimalStyle	An enumeration of style options for the ListView.
stretch	Boolean	false	If true, the LV will fill its container, allowing configured cells to `Grow` to fill the extra space.
title	Expression (String)		The title of the tile. The title is shown on the top of the tile.
viewMoreAction	Statement		The view more action. The 'View more' link is shown in the tile footer.
viewMoreLabel	Expression (String)	DisplayKey.get("Web.Tile.ViewMore")	The view more label of the tile. By default 'View More'
viewMoreVisible	Expression (Boolean)		An expression that indicates if the view more link is visible.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

LocationEntryPoint

top

An entry point for accessing a Location.

Attribute:	Type:	Default:	Description:
signature	String		The signature of the entry point, of the form "[location name]([args])".

LocationGroup

top

A group of locations (analogous to a directory that contains multiple files). When navigate to the group directly, it automatically forwards to the first visitable child LocationRef. When no accessible child LocationRef exists in this group, navigation directly to this group is disabled. When the "canVisit" expression of this group returns false, navigation to any descendents of this group is disabled. (A Location is considered a descendent of this group, if this Location is referenced by a child LocationRef of this group or has a "parent" attribute that points to this group or a descendent of this group.)

Child elements:

LocationEntryPoint Variable LocationRefIterator LocationRef Code

Attribute:	Type:	Default:	Description:
acceleratedMenuActions	Shared section reference		The ID of the AcceleratedMenuActions content for this location group. It will be inherited by all descendent Locations of this group by default. Normally not used, but use MenuActions instead.
afterEnter	Statement		A Gosu expression to run after this location group is entered. Because a location group is always entered before any descendent Location in the group, this expression will be executed before any descendent Location is entered.
beforeLeave	Statement		A Gosu expression to run before leaving this location group.
browserTitle	Expression (String)		The optional browser title of the location. If specified, the value will be displayed in the browser window title when this location is being viewed in the main content area.
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit this location Group or any Page (or sub-LocationGroup) in this group. If omitted, this LocationGroup can be visited only if at least one of its children can be visited.
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
id	String		ID of this Location. Must be unique among all Locations.
infoBar	Shared section reference		The ID of the InfoBar content for this group. InfoBar will be inherited by all descendent Locations of this group by default.
menuActions	Shared section reference		The ID of the MenuActions content for this location group. MenuActions will be inherited by all descendent Locations of this group by default.
menuLinks	Shared section reference		Normally NOT specified, in which case default MenuLinks are generated based on all visitable child LocationRefs of this group. MenuLinks are rendered in the left menu, if this group is not nested within another group; otherwise, they are rendered as page links next to the screen title.
menuLinksTitle	Expression (String)		An optional title for the default MenuLinks of this LocationGroup, if set, generates a title bar that can collapse and expand the MenuLinks
menuLinksTitleIcon	Expression (String)		An optional title icon for the default MenuLinks of this LocationGroup, if set, generates a title bar that can collapse and expand the MenuLinks
menuLinksTitleIconType	IconTypeEnum		An enumeration of icon types that determine what the 'menuLinksTitleIcon' property on the widget is referring to.
menuTree	Shared section reference		The ID of the MenuTree content for this location group. MenuTree will be inherited by all descendent Locations of this group by default.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
onAutoSave	Statement		A Gosu expression to run when this location group is moved to the auto-save cache.
onResume	Statement		A Gosu expression to run when this location is resumed from the autosave cache.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
tabBar	Shared section reference	TabBar()	ID of the TabBar content for this location group. Normally not specified since "TabBar()" is the default.
title	Expression (Object)		The title of the Location Group. When this is a root Location Group (i.e., does not belong to any parent Location), the title will be used as group title in the Unsaved-Work panel when any descendent Location has unsaved work. When this is not a root Location Group, the title may be used as the default label for the left menu item that leads to this Location Group.

LocationRefIterator

top

Creates as many copies of its content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside a LocationGroup.

Child elements:

LocationRef

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

LocationRef

top

A reference to a location

Attribute:	Type:	Default:	Description:
hideIfDisabled	Expression (Boolean)		An optional boolean expression. If returns true, this widget will not be displayed when the action is disabled. Default to true.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
label	Expression (String)		An optional Gosu expression the result of which is used as the label for the link to this location. Normally NOT specified, therefore allow a default label to be generated from the title of the target location.
location	Location reference		A Gosu expression pointing to the location this element refers to, of the form "[location name]([args])"
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. If specified, this will be used for the default MenuLink generated for this LocationRef.

LoginPage

top

Special Page element for the login page.

Child elements:

LocationEntryPoint Variable Screen ScreenRef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the location is canceled.
afterCommit	Statement		Gosu expression to run after the location is updated.
afterEnter	Statement		Gosu expression to run after this page is entered.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
alwaysInEditMode	Boolean	false	If true, the location will always go back to edit mode after a commit / cancel
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the location is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the location is updated but after the UI is validated.
beforeValidate	Statement		Gosu expression to run before the location is updated and before the UI is validated.
browserTitle	Expression (String)		The optional browser title of the location. If specified, the value will be displayed in the browser window title when this location is being viewed in the main content area.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this page. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". If not specified, validation issues on any entity that matches type of the "validationParameter" should be fixed on this page. No point to specify this attribute, if "validationParameter" is not defined.
hideLeftNavIfEmpty	Boolean	false	If true, the left navigation menu will be hidden when there are no menulinks
id	String		ID of this Location. Must be unique among all Locations.
infoBar	Shared section reference		ID of the InfoBar content for this location. Normally not specifed, so that the page inherits the infoBar from its ancestor LocationGroup.
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
onResume	Statement		A Gosu expression to run when this location is resumed from the autosave cache.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startEditing	Statement		Gosu expression to run when the location goes into edit mode.
startInEditMode	Expression (Boolean)	false	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it
title	Expression (Object)		The title of the location. The title is shown in the top title bar, unless the Screen uses a special TitleBar element to override it.
validateOnBundleCommit	Boolean	true	If false, the page will disable the automatic validation that happens on every commit. Only set this attribute to false if you're really sure you know what you're doing.
validationParameter	String		The name of an argument on a LocationEntryPoint, used for fixing entity validation issues.

LoginSubmitButton

top

Child elements:

LayoutConfig StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		The action to invoke when this button is clicked by the user.
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
hideChildrenIfReadOnly	Boolean	false	If true, this button will not be shown in read-only mode if it has child MenuItems but no action.
hideIfDisabled	Expression (Boolean)	true	If set to true, this widget will not be displayed when the action is disabled. Default to true.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
value	Expression (Object)		The value to be displayed on the button.
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

MediaGallery

top

A gallery node used to display MediaObjects.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideData	Boolean	false	If true, then the data table section of each gallery entry will be hidden.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mediaObjects	Expression (java.util.List)		A list of MediaImageExifObjects containing the relevant data to display as entries in the gallery.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
pageSize	Integer		Number of Media Objects to display per page. Size 0 will show all. Defaults to 0
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
title	Expression (String)		Title for the widget
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

MediaUploader

top

A widget used to upload media based files.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hasInformationInput	Boolean	false	If true, then each file import row in the Media Uploader will have an 'information' field associated with it that allows user input.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
title	String		Title for the widget
value	Expression (java.util.Collection)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

MenuActions

top

An element containing all "action links" in the left menu bar

Child elements:

Require Variable StandardMenuElement Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

MenuItemDivider

top

Simple divider between a set of menu items. Only works when used for "menu links" in the left menu bar.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

MenuItemIterator

top

Creates as many copies of its MenuItem content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside a hierarchical menu.

Child elements:

IteratorSort StandardMenuElement

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

MenuItem

top

An action item in a hierarchical menu

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
checked	Expression (Boolean)		An optional boolean expression. If true, this item will not be displayed as checked. Default to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfDisabled	Expression (Boolean)		An optional boolean expression. If returns true, this widget will not be displayed when the action is disabled. Default to true.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. Do not set this flag if this is an immediate child item under a flattened menu, because child items are still unknown at the time they need to be flattened onto the parent menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		An expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

MenuItemSet

top

A reusable set of MenuItems.

Child elements:

Require Variable StandardMenuElement Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

MenuItemSetRef

top

Includes a MenuItemSet by reference.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		The ID of the MenuItemSet to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
children	Expression (Object)		Gosu expression that takes an item and evaluates it to
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
disableActionForNonLeafNodes	Boolean	true	Whether or not to disable the action for non-leaf nodes. By default this is true, meaning that non-leaf nodes will not have an action listener.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

MenuLinks

top

An element containing all "menu links" in the left menu bar

Child elements:

Require Variable StandardMenuElement Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

MenuTree

top

Like MenuLinks, but supplies a TreeView instead of regular links

Child elements:

Require Variable AbstractTreeView

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

Messages

top

A widget that displays runtime web messages in the UI. If a Screen does not contain a child Messages element explicitly, all messages of the containing location will be rendered at the beginning of the Screen. The only time you want to add this widget into a PCF is when you need to change where messages are displayed for a particular Screen.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
groupScope	Boolean	false	This widget displays all messages from the containing Location by default. If "useScope" is set to true, this widget will display messages from the current Location Group instead.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

ModalCellChildType

top

Subclasses:

EmptyCell FormatCell ValueCellType

Require Variable ModalCellChildType Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

ModalCellRef

top

Includes a ModalCell by reference.

Attribute:	Type:	Default:	Description:
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
def	Shared section reference		The ID of the ModalCell to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		If defined, is the icon that will show in the header.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
required	Expression (Boolean)		If true, then the cell must be filled out by the user
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.Modifier	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.Modifier	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

MonetaryAmountCell

top

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
currency	Expression (typekey.Currency)		An expression to define the default currency when creating new MonetaryAmounts
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	gw.pl.currency.MonetaryAmount	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

MonetaryAmountInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
currency	Expression (typekey.Currency)		An expression to define the default currency when creating new MonetaryAmounts
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	gw.pl.currency.MonetaryAmount	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

NextCondition

top

Attribute:	Type:	Default:	Description:
condition	Expression (Boolean)		Gosu expression that indicates if this destination should be used. When clicking "Next" in the wizard, the screen will go to the first page for which the condition is true, and if all conditions are false will default to going to the next step in order.
destination	String		The ID of the step to go to

NoteBodyInput

top

An Input with the ability to convert note body to hyper links for URL and doc links

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ObjectFit

top

Values for the CSS Property 'object-fit'

Value:	Description:
none	The image is not resized.
contain	The image is scaled to maintain its aspect ratio while fitting within the defined dimensions. This can result in either horizontal or vertical 'letter-boxing'.
cover	The image is sized to maintain its aspect ratio while filling out the defined dimensions. This can result in the image being clipped.
fill	The image is sized to fill the element's content box. This can result in the image being stretched.
scale-down	The image is sized as if 'none' or 'contain' were specified; choosing whichever would result in a smaller image size.

OrgCell

top

A ListView cell specialized for an Organization.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Expression (Object)		The Location to use for user search criteria input, as a Gosu expression of the form "[popup name].push()".
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.Organization	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

OrgInput

top

An Input for Organizations.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.Organization	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

PCFConfigFiles

top

Used internally to combine all .pcfs into one big file. You should not use this element yourself.

Top-level element of all PCF files.

The most common type of Location which contains a single Screen.

Child elements:

LocationEntryPoint Variable Screen ScreenRef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the location is canceled.
afterCommit	Statement		Gosu expression to run after the location is updated.
afterEnter	Statement		Gosu expression to run after this page is entered.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
alwaysInEditMode	Boolean	false	If true, the location will always go back to edit mode after a commit / cancel
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the location is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the location is updated but after the UI is validated.
beforeValidate	Statement		Gosu expression to run before the location is updated and before the UI is validated.
browserTitle	Expression (String)		The optional browser title of the location. If specified, the value will be displayed in the browser window title when this location is being viewed in the main content area.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this page. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". If not specified, validation issues on any entity that matches type of the "validationParameter" should be fixed on this page. No point to specify this attribute, if "validationParameter" is not defined.
hideLeftNavIfEmpty	Boolean	false	If true, the left navigation menu will be hidden when there are no menulinks
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
id	String		ID of this Location. Must be unique among all Locations.
infoBar	Shared section reference		ID of the InfoBar content for this location. Normally not specifed, so that the page inherits the infoBar from its ancestor LocationGroup.
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
onResume	Statement		A Gosu expression to run when this location is resumed from the autosave cache.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startEditing	Statement		Gosu expression to run when the location goes into edit mode.
startInEditMode	Expression (Boolean)	false	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it
title	Expression (Object)		The title of the location. The title is shown in the top title bar, unless the Screen uses a special TitleBar element to override it.
validateOnBundleCommit	Boolean	true	If false, the page will disable the automatic validation that happens on every commit. Only set this attribute to false if you're really sure you know what you're doing.
validationParameter	String		The name of an argument on a LocationEntryPoint, used for fixing entity validation issues.

PanelColumn

top

A column of Panels (i.e. DetailViews, ListViews, etc.). It's used inside a PanelRow.

Child elements:

ChildOfPanel AbstractPanelDef

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

PanelDivider

top

A horizontal line for separating panels

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget

PanelIterator

top

Creates as many copies of its Panel content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName".

Child elements:

Variable IteratorSort ChildOfPanel AbstractPanelDef

Attribute:	Type:	Default:	Description:
appendPageInfo	Boolean	false	If true, will add something like " (1-15 of 100)" next to paging control, taking the paging information from this Iterator.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
checkBoxVisible	Expression (Boolean)		A Gosu expression (evaluates to a boolean) which designates whether or not the checkbox for a panel is visible. Does nothing if hasCheckBoxes is false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hasCheckBoxes	Boolean	false	If true, generates a checkbox on the left of each entry. Default is false unless the "toRemove" attribute is specified. This attribute only applies to the content entries directly under this iterator.
hideCheckBoxesIfReadOnly	Boolean	false	If true, then generated checkboxes will be invisible when the panel is read-only. Does nothing if hasCheckboxes=false. Defaults to false
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
pageSize	Integer		The number of elements in a single page, or 0 to disable paging.
toAdd	Statement		The Gosu expression that is evaluated to add a new value to the list. The value is exposed using the name specified by "elementName". An example would be "Foo.addToBars(bar)". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both. If the entries are not entities, toCreateAndAdd must be used instead of toAdd.
toCreateAndAdd	Expression (context-dependent)		The Gosu expression that is evaluated to create a new value and add it to the list. An example would be "Foo.addToBars(Foo.createNewBar())". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both.
toRemove	Statement		The Gosu expression that is evaluated to remove a value from the Iterator. The value is exposed using the name specified by "elementName". Must be defined for the user to be able to remove values from the iterator.
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)	true	Boolean expression which, if false, completely hides the widget and all its children

PanelRef

top

An optionally collapsible container that includes a panel (such as a DetailView, ListView, PanelSet or CardView) and (optionally) supplies it with title bar, toolbar, and instructional text.

Child elements:

TitleBar Toolbar Verbatim AbstractPanelDef

Attribute:	Type:	Default:	Description:
accordionGroupId	String		If set then only one member of the "accordion group" can be expanded at a time. So expanding this Container will collapse all other Containers with the same accordion group id.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
collapsible	Boolean	false	If true, the Container will have a title bar section and will be collapsible. Purely a visual effect.
def	Shared section reference		ID of the panel (CardViewPanel,ChartPanel,DetailViewPanel,ListDetailPanel,PanelRow,PanelSet,SearchPanel,TreeViewPanel) to include by reference
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
sharedPersistentCollapseId	String		Normally the collapsed state of a Container is persisted using its fully qualified id, so a particular container on a particular page will remember whether it is expanded or collapsed. Setting a sharedPersistentCollapseId allows multiple Containers, or the same Container used on different pages, to share their collapsed state. So collapsing a Container with sharedPersistentCollapseId "X" on one page will cause a Container with that same id on another page to be collapsed when that page is visited.
startCollapsed	Boolean	false	If true, and the Container is set to collapsible: true, then the Container will start out collapsed. However, after the user has interacted with the Container, its collapsed/open state will persist on the client. Purely a visual effect.
titleBadgeOnlyVisibleWhenCollapsed	Boolean	false	If true, then the Badge in the TitleBar section of the Container will only be visible when the Container is collapsed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

PanelRow

top

A row of Panels (i.e. DetailViews, ListViews, etc.). Useful for arranging multiple PanelColumns horizontally.

Child elements:

Require Expose ExposeIterator ExposeRowTree ReferencedWidget ChildOfPanel AbstractPanelDef

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
columnDivider	Boolean	false	If true, there will be a visible divider between each child. Defaults to false
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

PanelSet

top

A reusable set of panel(s).

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget Verbatim Layout ChildOfPanel AbstractPanelDef Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

PerformanceIndicator

top

Performance Indicator

Child elements:

BadgeProperties

Attribute:	Type:	Default:	Description:
action	Statement		Expression that provides a destination PCF for a clickable link
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
color	Expression (gw.api.web.color.GWColor)		Text color of an indicator's value. Preferably use gw.api.web.color.PIColors.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (String)		Label of an indicator.
maxLabelWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Overrides the SASS variable for max width of Indicator's label.
percentageFormat	Boolean	false	An expression that indicates if the value should be formatted as a percentage value. Applicable only to numeric values.
value	Expression (context-dependent)		Value of an indicator.
valueType	Type reference	java.lang.Number	The type of the value expression.
visible	Expression (Boolean)		An expression that indicates if the indicator is visible.

PerformanceIndicatorRow

top

A row that can be placed at the top of a DetailViewTile. This row can contain only one or more PerformanceIndicator widgets.

Child elements:

PerformanceIndicator

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
visible	Expression (Boolean)		An expression that indicates if the row is visible.

PickerCell

top

A cell with a picker icon

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

PickerInput

top

An input with a picker icon

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

PickerLink

top

A link that picks a value using a popup. The action should push a picker popup and onPick should be set to a Gosu fragment that will process the result picked by the popup

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
styleClass	LinkStyleClass		CSS style class for the link; for instance, "miniButton" makes the link appear as a small button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

PickerMenuItem

top

A menu item that picks a value using a popup. The action should push a picker popup and onPick should be set to a Gosu fragment that will process the result picked by the popup

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

PickerToolbarButton

top

A toolbar button that picks a value using a popup. The action should push a picker popup and onPick should be set to a Gosu fragment that will process the result picked by the popup

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flags	String		A very special expression defining what flags (see ToolbarFlag) must be checked for the toolbar button to be available (= not grayed out). All processing of flags happens on the browser-side. The flags syntax is a comma-separated list of predicates (with no space after each comma), and all predicates must be satisfied for the button to be available. Each predicate consists of a operator followed by a space and then the name of a ToolbarFlag. For instance, flags="one Foo,no Bar" means "only available if there is exactly one Foo checkbox checked and no Bar checkboxes checked". The available operators are: one, two, any, all, no, exists (same as any).
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		Label to render.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

Popup

top

A page which is always popped on top of a another base Page. A Popup is usually used as a picker dialog for the base page, therefore it can return a value. Unlike regular pages which must be attached to the application hierarchy through their parent location group at configuration time, a Popup can be attached to the application hierarchy dynamically through its base page.

Child elements:

LocationEntryPoint Variable Screen ScreenRef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the location is canceled.
afterCommit	Statement		Gosu expression to run after the location is updated.
afterEnter	Statement		Gosu expression to run after this page is entered.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
alwaysInEditMode	Expression (Boolean)		If true, the location will always go back to edit mode after a commit / cancel
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the location is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the location is updated but after the UI is validated.
beforeValidate	Statement		Gosu expression to run before the location is updated and before the UI is validated.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
id	String		ID of this Location. Must be unique among all Locations.
infoBar	Shared section reference		ID of the InfoBar content for this location. Normally not specifed, so that the page inherits the infoBar from its ancestor LocationGroup.
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
returnType	Type reference		The type of entity this popup returns.
startEditing	Statement		Gosu expression to run when the location goes into edit mode.
startInEditMode	Expression (Boolean)	false	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it
title	Expression (Object)		The title of the location. The title is shown in the top title bar, unless the Screen uses a special TitleBar element to override it.
validateOnBundleCommit	Boolean	true	If false, the page will disable the automatic validation that happens on every commit. Only set this attribute to false if you're really sure you know what you're doing.

PopupWizard

top

A Location with multiple Screens that can return a value

Child elements:

LocationEntryPoint Variable AbstractWizardStepsRef AbstractWizardStepsDef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the Wizard is canceled. See ActionBase for kinds of available actions
afterFinish	Statement		Gosu expression to run after the user gets all the way through and finishes the Wizard.
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the Wizard is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the wizard state is persisted into database.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
cancelWarning	Expression (String)		Gosu expression that returns a message to display in a confirmation dialog when the user attempts to cancel this wizard
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
id	String		ID of this Location. Must be unique among all Locations.
infoBar	Shared section reference		ID of the InfoBar content for this location (just below the TabBar and above the main content)
inheritMenuLinks	Boolean	false	If true, this wizard will have no MenuLinks of its own, and will inherit MenuLinks from its ancestor location group (if any).
menuActions	Shared section reference		ID of the optional MenuActions content for this location (in the bottom of the left menu)
menuLinks	Shared section reference		Normally NOT specified, in which case default MenuLinks (in the left menu) are generated based on steps of this wizard.
menuTree	Shared section reference		ID of the optional MenuTree content for this location (in the left menu). This should only be used if the wizard is also overriding the menuLinks attribute
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
returnType	Type reference		The type of entity this popup wizard returns.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startInEditMode	Expression (Boolean)	true	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it. Default to true for Wizard.
tabBar	Shared section reference	TabBar()	ID of the TabBar content for this location group. Normally not specified since "TabBar()" is the default.
title	Expression (Object)		The optional title for this wizard. If not specified, only the current step title shows in the top title bar. If specified, this wizard title and the current step title will both show in the title bar.

PostOnChange

top

DO NOT USE: intended for internal use only. Defines the postOnChange properties for a widget.

Attribute:	Type:	Default:	Description:
deferUpdate	Boolean	true	If true, the post on change value will be updated after all other values on the page. If the value is used in visible expressions this can affect which other values will be updated by the post on change.
disablePostOnEnter	Expression (Boolean)		Boolean expression, if evaluated to true when the page is entered, this field will not trigger post on change. Defaults to false.
onChange	Statement		Gosu expression to invoke when the value is changed by the user. Currently only supported for immediate-post-back.

PreFormattedTextInput

top

An input which renders as preformatted monospaced text

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

PrivacyCell

top

A widget that always encrypts any existing value that has been previously committed, but allows the user to enter new value when in edit mode.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
encryptionExpression	Expression (String)		An optional expression to encrypt the existing model value, exposed as "VALUE". If not set, a default encryption will be used.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntries	Integer	-1	Integer that determines the max number of entries to show for a comma-separated text cell. Shows "..." at the end
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shouldEncryptReflectedValue	Boolean	true	If true, reflected values will be encrypted before being displayed. If false, reflected values will not be encrypted before being displayed
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.String	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

PrivacyInput

top

A widget that always encrypts any existing value that has been previously committed, but allows the user to enter new value when in edit mode.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
encryptionExpression	Expression (String)		An optional expression to encrypt the existing model value, exposed as "VALUE". If not set, a default encryption will be used.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
shouldEncryptReflectedValue	Boolean	true	If true, reflected values will be encrypted before being displayed. If false, reflected values will not be encrypted before being displayed
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ProducerCodeInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the picker popup has been used to pick a value. The picked value is available as the special symbol "PickedValue"
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.ProducerCode	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ProgressInput

top

A widget which indicates the progress of a long running operation. This widget updates its status from the server automatically until the operation completes. When the operation completes, if this widget has "actionOnComplete" set, it will invoke the action; otherwise it will refresh the nearest enclosing widget with "refreshOnProgressComplete" (if any).

Child elements:

LayoutConfig

Attribute:	Type:	Default:	Description:
actionOnComplete	Statement		An optional action, if set, will be executed when the long operation completes. When this attribute is set, the user is not allowed to interact with the app when the long operation is in progress.
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideAnimation	Expression (Boolean)		An optional boolean expression, if returns true, no animated gif will be rendered on the UI when the widget is polling the server for progress update. Normally you don't want to set this attribute, therefore allow a visual indication to the user that this widget is updating itself.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
percentage	Expression (java.lang.Double)		An expression that returns percentage of completion: -1: the operation is in progress but with unknown percentage completed (The widget will poll the server for new progress); 0: no operation is in progress; >0 and <100: actual %completion (The widget will poll the server for new progress); 100: the operation is completed (The widget will invoke "actionOnCompletion" if defined)
status	Expression (String)		An optional message to display
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

RadioButtonCell

top

A ListView cell containing a single radio button.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
radioButtonGroup	String		Logical name of the "group" of radio buttons, of which only one can be checked at a time
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.Boolean	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

RangeAxis

top

Attribute:	Type:	Default:	Description:
label	Expression (String)		An expression for the label of this axis
lowerBound	Expression (java.lang.Double)		The lower bound expression for the axis range. If omitted the minimum value of all the data series is used. Ignored for a category axis
upperBound	Expression (java.lang.Double)		The upper bound expression for the axis range. If omitted the maximum value of all the data series is used. Ignored for a category axis
useWholeNumbers	Boolean	false	If true, and if the values are numeric, tick values will only be display as whole numbers

RangeCell

top

A ListView cell with extra attributes for a value field which is restricted by a value range

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionGroupLabel	Expression (String)		Optional Gosu expression, if specified, the options will be displayed in groups based on its group label. Defaults to null. The element value is exposed as "VALUE".
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

RangeCellType

top

Base type for all ListView cells bound to a value which is restricted by a value range

Subclasses:

AssigneeCell RangeCell RangeRadioCell

RangeInput

top

An input bound to a value which is limited by a range

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
multiSelect	Boolean	false	Indicates that this input is a multiselect. If true, the value expression should refer to an array.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionGroupLabel	Expression (String)		Optional Gosu expression, if specified, the options will be displayed in groups based on its group label. Defaults to null. The element value is exposed as "VALUE".
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
shuttleList	Boolean	false	If true, the input will be rendered as a "shuttle" input, allowing the user to select options by moving them from one list to another.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

RangeRadioCell

top

A RangeCell which renders as radio buttons. Only use this when you know that the range of values is limited to two or three options.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
stacked	Expression (Boolean)	false	If true, the contents of the Widget will be stacked vertically.
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

RangeRadioInput

top

A RangeInput which renders as radio buttons. Renders 1 radio button for each value of the range.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionIcon	Expression (String)		An optional expression to specify an icon for each option. The option value is exposed as "VALUE". The return value's type is determined by OPTION_ICON_TYPE
optionIconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. The option value is exposed as "VALUE". If not set will default to its font color.
optionIconType	IconTypeEnum		An enumeration of icon types that determine what the 'optionIcon' property on the widget is referring to.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
stacked	Expression (Boolean)	false	If true, the contents of the Widget will be stacked vertically.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ReferencedIterator

top

Specifies the referenced iterator and optionally its flags.

Attribute:	Type:	Default:	Description:
flags	String		The flags for the iterator
valueType	Type reference		The valueType of the widget symbol, such as "String" or "Policy"
widget	String		The name of widget

ReferencedRowTree

top

Specifies the referenced row tree.

Attribute:	Type:	Default:	Description:
widget	String		The name of the row tree

ReferencedWidget

top

Specifies the widget needed by the containing section.

Attribute:	Type:	Default:	Description:
widget	String		The name of the widget

ReflectCondition

top

Used to split the "value" of a Reflect element based on multiple conditions

Attribute:	Type:	Default:	Description:
condition	Reflect expression		A boolean expression. The first ReflectCondition whose "condition" evaluates to true is used for its "value". If no ReflectConditions evaluate to true, then the reflector's value is unchanged (if you want it to revert to "null" you need to add a ReflectCondition at the end with condition="true" value="null")
value	Reflect expression		The value to use if the condition evaluates to true, relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1.

Reflect

top

Defines the client reflection properties of a single reflector. See the Reflection spec for more detail.

Child elements:

ReflectCondition

Attribute:	Type:	Default:	Description:
available	Reflect expression		Boolean expression defining the availability of the reflector, relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1.
custom	Javascript expression		Custom JavaScript expression, normally relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1. Theoretically, you can use this expression to do ANYTHING browser side. The expression will be invoked when the value of any of the reflection triggers changes.
inputMask	Reflect expression		Gosu expression defining the reflector input mask, relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1.
reflectDirectChangesOnly	Boolean	false	If true, this reflector only reflects direct changes on the trigger (i.e., ignores reflection propagation to indirect reflector). Default to false.
triggerIds	String		Refers to the "id" attribute of the trigger, the value which when changed will alter the value of this element. Multiple ids can be separated by ","
value	Reflect expression		Gosu expression defining the value of the reflector, relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1. If you do not specify "value" and the value of the trigger is a proper substring of the value of the reflector, then value will be determined implicitly (i.e. if the trigger value is "Foo.Bar" and the reflector is "Foo.Bar.SomeField", the implicit reflection value is "VALUE.SomeField"). You can also use ReflectConditions instead of "value"
valueRange	Reflect expression		Gosu expression defining the reflector value range,relatively to the trigger value, which will be exposed as "VALUE" if there is a single trigger or as "VALUE1", "VALUE2", etc. for multiple triggers. When there are multiple triggers, the index of the active trigger will be exposed as "TRIGGER_INDEX", for example, when the reflection is triggered by "VALUE1", "TRIGGER_INDEX" will be 1.

RemoveButton

top

A button to remove entries for the nearest iterator control after. This button is only visible when the associated iterator control defines "toRemove". If you want to add both "add" and "remove" button to the iterator, you can use instead.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
flags	String		A very special expression defining what flags (see ToolbarFlag) must be checked for the toolbar button to be available (= not grayed out). All processing of flags happens on the browser-side. The flags syntax is a comma-separated list of predicates (with no space after each comma), and all predicates must be satisfied for the button to be available. Each predicate consists of a operator followed by a space and then the name of a ToolbarFlag. For instance, flags="one Foo,no Bar" means "only available if there is exactly one Foo checkbox checked and no Bar checkboxes checked". The available operators are: one, two, any, all, no, exists (same as any).
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		label for this button
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Expression which determines whether or not the confirmation message should be shown
tooltip	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression specifying whether the remove button is visible. By default the remove button is visible when the Iterator has "toRemove" defined.

Require

top

Specifies that a symbol of a given name and type is required to exist in order to dynamically include the parent widget. During verification of the pages, this element actually defines the symbol with the given name and type and a null value (so that the contents of the widget can be verified). In this way the Require element acts much like a method argument.

Attribute:	Type:	Default:	Description:
name	String		The name of the required symbol
type	Type reference		The type of the required symbol, such as "String" or "Policy"

RiskClassCell

top

A ListView cell specialized for RiskClass fields.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
coveragePattern	Expression (gw.api.productmodel.ClausePattern)
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
policyLinePattern	Expression (gw.api.productmodel.PolicyLinePattern)
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.RiskClass	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

RiskClassInput

top

Version of Input specialized for ClassCode fields

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearEnabled	Boolean	false	Whether the user should be allowed to clear the selected value. If "true", an icon will be available which, when clicked, will clear the widget. This attribute will always be overridden and set to "true" if freeInputEnabled is set to false.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from the picker popup before it is written to the model value of this widget. The picked value is available as the special symbol "PickedValue"
coveragePattern	Expression (gw.api.productmodel.ClausePattern)
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
freeInputEnabled	Boolean	true	If true, the user may enter a free-text value. If this property is set to false, the clearEnabled attribute will be treated as true to allow for users to delete their picked selection.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
pickLocation	Statement		The picker popup used to pick a value, as a Gosu statement of the form "[popup name].push(...)".
policyLinePattern	Expression (gw.api.productmodel.PolicyLinePattern)
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.RiskClass	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

RowIterator

top

Creates as many copies of its Row content as there are components in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside a ListViewPanel or another RowIterator.

Child elements:

Variable ToolbarFilter ToolbarFlag IteratorSort AbstractRow

Attribute:	Type:	Default:	Description:
appendPageInfo	Boolean	false	If true, will add something like " (1-15 of 100)" next to paging control, taking the paging information from this Iterator.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoAdd	Expression (Boolean)		An optional Boolean Gosu expression, if evaluated to true, add numEntriesToAdd elements to this iterator when entering the page, if the page is in edit mode upon enter. Normally not set, unless the iterator has less entries than required; otherwise, the user may have to manually remove unwanted entries that are automatically added.
canPick	Expression (Boolean)	true	Boolean expression which, if it evaluates to false, hides the select button (but not the column). Only applies if pickValue is defined.
cellNavOnEnter	Boolean	false	If true, ENTER key will navigate thru editable cells in this row iterator. Default to false, in which case the user can navigate thru the cells using ALT+SHIFT+<arrow-key>.
checkBoxVisible	Expression (Boolean)		A Gosu expression (evaluates to a boolean) which designates whether or not the checkboxes are visible. Does nothing if hasCheckBoxes is false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		Not applicable for Dashboards.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which determines whether any of the columns can be editable. It is an error to make any Cell editable if this attribute is false; conversely, it is an error to use this RowIterator over a IQueryBeanResult if the attribute is true. NOTE: Always operates in read-only mode in Dashboard context.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
forceRefreshDespiteChangedEntries	Boolean	false	If true, the iterator will refresh its entries even if they have changed. This has risks. Refreshing from an IQueryBeanResult value will ignore newly added or removed entries. Changed or newly added entries may be reordered or moved out of the currently visible page, possibly bypassing UI validation. User input that cannot be written to the underlying data (such as malformed date strings) may be lost. Use with care. Safest on list or array iterators that don't have paging or contain only simple inputs such as checkboxes or dropdowns .
hasCheckBoxes	Boolean	false	If true, generates a checkbox on the left of each content row. Default is false unless the "toRemove" attribute is specified. This attribute only applies to the content rows directly under this iterator, and not to rows embedded under a child iterator or RowSetRef.
height	String	-1	Do not use, set the height at parent ListView level instead.
hideCheckBoxesIfReadOnly	Boolean	false	If true, then generated checkboxes will be invisible when the listview is read-only. Does nothing if hasCheckboxes=false. Defaults to false.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
numEntriesRequired	Integer	0	Number of entries that must be filled out to pass validation on this page.
numEntriesToAdd	Integer	1	An optional attribute, if set, overrides number of entries to add when the add button is pushed. Default to 1. Normally not set. If set to a value greater than 1, any entry that is not modified by the user after it's added will be removed before commit the page. It's a risk of potential data loss. USE WITH CAUTION. .
pageSize	Integer		The number of elements in a single page, or 0 to disable paging. The default value is specified in ListViewPageSizeDefault parameter in config.xml.
pickLocation	Statement		Not applicable for Dashboards.
pickValue	Expression (context-dependent)		Gosu expression specifying what value a row will select. If specified, then adds a "SELECT" button to the left of each content row.
pickWidth	Integer		The width of the pick column cell, in pixels, if specified.
quickAddOnEnter	Boolean	false	If true, ENTER key will navigate you thru editable cells, and add a new entry when you are at the last editable cell of this row iterator. Adding a new entry via ENTER key does not submit or validate previously entered data. Default to false. This is an experimental attribute only applicable to very basic ListView configuration and for users who do not have full keyboard access. Do not set this property in other cases. Not applicable for Dashboards.
selectLabel	Expression (String)	DisplayKey.get("Button.Select")	Overrides the text on the "SELECT" button. Only applies if pickValue is defined.
startChecked	Expression (Boolean)		A Gosu expression which, if true, means the checkbox will start as checked.
toAdd	Statement		The Gosu expression that is evaluated to add a new value to the list. The value is exposed using the name specified by "elementName". An example would be "Foo.addToBars(bar)". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both. If the entries are not entities, toCreateAndAdd must be used instead of toAdd.
toCreateAndAdd	Expression (context-dependent)		The Gosu expression that is evaluated to create a new value and add it to the list. An example would be "Foo.addToBars(Foo.createNewBar())". Either toAdd or toCreateAndAdd must be defined for the user to add entries to the iterator; however you cannot define both.
toRemove	Statement		The Gosu expression that is evaluated to remove a value from the Iterator. The value is exposed using the name specified by "elementName". Must be defined for the user to be able to remove values from the iterator.
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
validationLabel	Expression (String)		Validation label for errors associated with the RowIterator as a whole.
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

Row

top

A row used inside a ListViewPanel. May contain multiple cells.

Child elements:

AbstractCell

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes all the child cells in this row read-only. This is a convenient alternative for setting the "editable" attribute on each child cell. This attribute can be used to prevent modifying the cell data directly on the UI; however, it does not prevent modifying the underlying data indirectly (for example, through a Toolbar button).
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
highlighted	Expression (Boolean)		If true, the row will be highlighted.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
refreshOnProgressComplete	Expression (Object)		Only meaningful when this widget contains a Progress widget. Specifies an entity to refresh when the Progress widget completes its operation, at which point this widget will re-render itself.
renderAsSmartHeader	Boolean	false	If true, renders this row as a smart header. Default to false.
useArchivedStyle	Expression (Boolean)		An optional boolean expression, if returns true, all child widgets of the row will be rendered in "archived" style
useSubHeaderStyle	Expression (Boolean)		If true, renders this row in sub-header style. Default to false.
useTitleStyle	Expression (Boolean)		If true, renders this row in title style. Default to false. Do not use in normally formatted ListViews.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

RowSet

top

A reusable set of rows that can be included by reference.

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget AbstractRow

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

RowSetRef

top

Includes a RowSet by reference.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		The ID of the RowSet to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

RowTree

top

Creates an expandable tree based on its Row child, as defined by the elements in the array referenced by "value". Supplies the component value to the created content as "elementName". Used inside a ListViewPanel.

Child elements:

Variable ToolbarFilter ToolbarFlag IteratorSort Row

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
canPick	Expression (Boolean)	true	Boolean expression which, if it evaluates to false, hides the select button (but not the column). Only applies if pickValue is defined.
checkBoxVisible	Expression (Boolean)		A Gosu expression (evaluates to a boolean) which designates whether or not the checkboxes are visible. Does nothing if hasCheckBoxes is false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
containerAction	Statement		A Gosu expression evaluating to the action on the label displayed for a parent row in the tree. Only applicable if containerType is specified.
containerLabel	Expression (String)		A Gosu expression evaluating to the label displayed for a parent row in the tree. Only required if containerType is specified.
containerLabelColspan	Integer	1	EXPERIMENTAL, DO NOT USE!!! If the number is greater than 1, no more cells will be rendered to the right of the containerLabel cell.
containerType	Type reference		The type of element represented by parent nodes in the tree, if they are of a different type than the leaf nodes.
contentType	Type reference		The type of element represented by leaf nodes in the tree. All Cells after the first will only be populated for elements of this type. (Note that non-leaf nodes of this type will also have their cells populated.)
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hasCheckBoxes	Boolean	false	If true, generates a checkbox on the left of each content row. Default is false unless the "toRemove" attribute is specified. This attribute only applies to the content rows directly under this iterator, and not to rows embedded under a child iterator or RowSetRef.
height	String	-1	Do not use, set the height at parent ListView level instead.
hideCheckBoxesIfReadOnly	Boolean	false	If true, then generated checkboxes will be invisible when the listview is read-only. Does nothing if hasCheckboxes=false. Defaults to false
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
pageSize	Integer	0	The number of elements in a single page. ** Note: pageSize is not supported for RowTree. Default is set to 0 to disable paging.
pickValue	Expression (context-dependent)		Gosu expression specifying what value a row will select. If specified, then adds a "SELECT" button to the left of each content row.
preserveExpansionStateOnRefresh	Boolean	false	If true, whenever the value expression is evaluated and returns a new tree object then expand the same nodes in the new tree that were expanded in the previous tree, using the treeNode.DataKey property to match new and old nodes
selectLabel	Expression (String)		Overrides the text on the "SELECT" button. Only applies if pickValue is defined.
startChecked	Expression (Boolean)		A Gosu expression which, if true, means the checkbox will start as checked
value	Expression (gw.api.tree.TreeNode)		A Gosu expression that evaluates to the top-level elements from which to create the tree. Must evaluate to an object implementing gw.api.tree.TreeNode.

Scope

top

Specifies a scope where this worksheet is allowed to show.

Attribute:	Type:	Default:	Description:
location	Location reference		The location which, when used as the top location in the main frame, allows this worksheet to be visible. Format: "[location name]([args])", or "*" for any location.

Screen

top

The top GUI widget for the visible content of a page.

Child elements:

Require Variable TitleBar Toolbar Verbatim Messages AlertBar ChildOfPanel AbstractPanelDef Calendar ColumnDashboard Code

Attribute:	Type:	Default:	Description:
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
id	String		ID of this Screen. It must end with "Screen". It has to be unique if this Screen is defined in a separate file (i.e. referenceable by a ScreenRef).
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

ScreenRef

top

Includes a Screen by reference

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		ID of the screen to include by reference
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the screen will be loaded whose "mode" matches the evaluated "mode" of this element. If no screen is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown

SearchItem

top

A search item under the tab menu.

Attribute:	Type:	Default:	Description:
afterFailure	Statement		Optional expression which performs some action after navigating to the search page after a failure (typically modifying the search criteria). The search criteria are exposed as searchCriteria, and the user's input as searchText.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearSearchText	Boolean	true	If true, the search text is cleared after performing the search.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputMask	Expression (String)		An optional gosu expression that returns a string to use as the input mask. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value.
label	Expression (String)		Gosu expression for the label of the item
onFailure	Expression (pcf.api.Location)		Expression which navigates to the appropriate search page if the search fails. The user's input is exposed as searchText.
onResult	Statement		Expression which navigates to the appropriate location when a single result is successfully returned. The result is exposed as a symbol called "result".
property	Expression (gw.lang.reflect.IPropertyInfo)		An entity property whose field validator is to generate the input mask on the search box.
search	Expression (Object)		Expression which performs the search, taking the user's input as searchText and returning a single result, or null on failure.
validationError	Expression (String)		Expression which returns the error to display on a failed search. The user's input is exposed as searchText.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

SearchPanel

top

A special panel to facilitate performing searches. The Search Panel typically contains a DetailView to enter search criteria and a ListView to display search result. The search criteria entry DetailView is always editable, no matther if the enclosing context is being edited or not.

Child elements:

ChildOfPanel AbstractPanelDef Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
cachingEnabled	Expression (Boolean)	true	If false, disables all caching of the criteria and results of this Searcher. Defaults to true.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
clearInvisibleInputs	Boolean	false	If true, clears invisible Inputs with values that are left over from a previous state of the screen. Limitation: If a field appears twice on the screen, once visible and once invisible, both inputs will be cleared.
criteriaName	String		The name by which the search criteria will be exposed as a symbol. Typically the criteria are edited by a DetailView.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
maxSearchResults	Expression (Object)		If specified, sets the maximum number of search results that can be returned by this search. If more than this number of results are returned, an error message will be displayed instead telling the user to refine their search. Values of 0 or less are ignored - that is no maximum will be imposed
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	none	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
resultCachingEnabled	Boolean	true	If false, disables caching of search results (while leaving caching of criteria). Defaults to true. Moot if cachingEnabled is false.
resultsName	String		The name by which the search results (normally a List, Array, or IQueryBeanResult) will be exposed as a symbol. Typically the results are shown in a ListView.
search	Expression (Object)		Gosu expression that does the actual search.
searchCriteria	Expression (context-dependent)		Gosu expression that creates the search criteria. The return type must be serializable.
searchCriteriaType	Type reference		The type of the search criteria, which must be serializable
searchOnEnter	Expression (Boolean)		An optional Gosu expression, if true, and if there are no search results cached from last visit to this page, the SearchPanel will run a search as soon as the user enters the page
searchOnRefresh	Boolean	true	If true, the SearchPanel will re-run the last query when the page is refreshed. Only applicable when the search results type is a Query.
searchResultsType	Type reference		The type of the search expression.

Attribute:	Type:	Default:	Description:
destination	String		The ID of the step to go to
label	Expression (String)		Gosu expression for the label to display on this button
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
visible	Expression (Boolean)	true	Gosu expression that indicates whether this button should appear on the screen. Tree.If not specified, the button will always appear

Spacer

top

A general spacer node used to help in general layout.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget.
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

StandardMenuElement

top

Subclasses:

AbstractAddMenuItem MenuItemDivider MenuItemIterator MenuItem MenuItemSetRef MenuItemTree PickerMenuItem SearchItem

SystemAlertBarElement

top

A single element in SystemAlertBarBar.

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
styleClass	LinkStyleClass		CSS style class for the link; for instance, "miniButton" makes the link appear as a small button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget.

SystemAlertBar

top

An area below TabBar for displaying system alert information

Child elements:

Require Variable SystemAlertBarElement

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TabBarLink

top

A hyperlink in the right area of the TabBar

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TabBarLogout

top

A special Logout link in the right area of the TabBar

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TabBar

top

The set of tabs at the top of the browser window

Child elements:

Variable TabBarUnsavedWork Tab TabBarLink TabBarLogout HiddenLink

Attribute:	Type:	Default:	Description:
hideQuickJump	Expression (Boolean)		Boolean expression which, if true, hides QuickJump widget in the tab bar.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
systemAlertBar	Shared section reference		System alert bar, used to display system wide alert messages

TabBarUnsavedWork

top

Tab bar link leads to unsaved work

Attribute:	Type:	Default:	Description:
id	String		id of the widget. Must be unique among the siblings
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

Tab

top

A single Tab in the TabBar

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
hideIfDisabled	Expression (Boolean)		An optional boolean expression. If returns true, this widget will not be displayed when the action is disabled. Default to true.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TemplatePanelContents	top
A wrapper element that contains the contents of a TemplatePanel. The content are rendered inside an enclosing HTML page, therefore they should not start with "...".
No attributes

TemplatePanel

top

A panel that renders readonly content based on a Gosu block. This element is typically used to aggregate external content inside a Guidewire page. The content of this Panel is rendered inside an enclosing HTML page, therefore it should not start with "...".

Child elements:

ReferencedWidget TemplatePanelContents

Attribute:	Type:	Default:	Description:
actionHandler	Expression (gw.api.web.template.TemplatePanelActionHandler)		A handler object whose 'action' method will be invoked if the template's client side calls the gw.api.submitTemplateAction function, passing in this template's id and a JSON object as arguments. The JSON from the client will be given as the argument to the 'action' method. The 'action' method is called as part of a normal Pebbles request; all input values are sent to the server, variables are refreshed (if marked as 'recalculateOnRefresh') and the UI is re-rendered. The 'action' method can do anything a normal menu or button action can do, including navigating to other pages.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.
renderCall	Statement		A method call to write output to the provided writer. Usually renders a Gosu template, e.g. MyTemplate.render(__writer, __escaper, other args). This attribute has access to a symbol named __writer of type java.io.Writer (used to capture the template output), a symbol named __escaper of type gw.lang.parser.template.StringEscaper (used to escape values embedded in the template) and a symbol named __helper of type gw.api.web.template.TemplatePanelHelper (useful for calling nested templates) plus String arguments for each of the ReferencedWidgets for this panel. The call can also access variables and functions defined in the same PCF file. Either renderCall can be specified or the body of the template can be non-empty, but not both.
updateHandler	Expression (gw.api.web.template.TemplatePanelUpdateHandler)		A handler object whose 'update' method will be invoked if the template's client side calls the gw.api.updateTemplate function, passing in this template's id and a JSON object as arguments. The JSON from the client will be given as the argument to the 'update' method and the JSON returned by the 'update' method will be returned to the client. The 'update' method is not called as part of a normal Pebbles request; no input values will be saved or variables refreshed. Any client side state that is needed by the 'update' method must be explicitly passed in the JSON. The 'update' method must not attempt to navigate elsewhere, it should just return updated data to the client

TemplateTile

top

A panel that renders content inside of a Tile based on a Gosu block. This element is typically used to aggregate external content inside a Guidewire page. The content of this Panel is rendered inside an enclosing HTML page, therefore it should not start with HTML tag.

Child elements:

Require Variable TemplatePanelContents TileActions

Attribute:	Type:	Default:	Description:
actionHandler	Expression (gw.api.web.template.TemplatePanelActionHandler)		A handler object whose 'action' method will be invoked if the template's client side calls the gw.api.submitTemplateAction function, passing in this template's id and a JSON object as arguments. The JSON from the client will be given as the argument to the 'action' method. The 'action' method is called as part of a normal Pebbles request; all input values are sent to the server, variables are refreshed (if marked as 'recalculateOnRefresh') and the UI is re-rendered. The 'action' method can do anything a normal menu or button action can do, including navigating to other pages.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
renderCall	Statement		A method call to write output to the provided writer. Usually renders a Gosu template, e.g. MyTemplate.render(__writer, __escaper, other args). This attribute has access to a symbol named __writer of type java.io.Writer (used to capture the template output), a symbol named __escaper of type gw.lang.parser.template.StringEscaper (used to escape values embedded in the template) and a symbol named __helper of type gw.api.web.template.TemplatePanelHelper (useful for calling nested templates) plus String arguments for each of the ReferencedWidgets for this panel. The call can also access variables and functions defined in the same PCF file. Either renderCall can be specified or the body of the template can be non-empty, but not both.
title	Expression (String)		The title of the tile. The title is shown on the top of the tile.
updateHandler	Expression (gw.api.web.template.TemplatePanelUpdateHandler)		A handler object whose 'update' method will be invoked if the template's client side calls the gw.api.updateTemplate function, passing in this template's id and a JSON object as arguments. The JSON from the client will be given as the argument to the 'update' method and the JSON returned by the 'update' method will be returned to the client. The 'update' method is not called as part of a normal Pebbles request; no input values will be saved or variables refreshed. Any client side state that is needed by the 'update' method must be explicitly passed in the JSON. The 'update' method must not attempt to navigate elsewhere, it should just return updated data to the client
viewMoreAction	Statement		The view more action. The 'View more' link is shown in the tile footer.
viewMoreLabel	Expression (String)	DisplayKey.get("Web.Tile.ViewMore")	The view more label of the tile. By default 'View More'
viewMoreVisible	Expression (Boolean)		An expression that indicates if the view more link is visible.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TextAreaCell

top

A ListView cell containing a multi-line text area

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntries	Integer	-1	Integer that determines the max number of entries to show for a comma-separated text cell. Shows "..." at the end
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		If greater than 0, represents roughly the number of rows of text displayed in the text area in edit mode, and the maximum rows in read only mode. Otherwise edit mode will be a set to sensible default.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.String	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

TextAreaInput

top

An Input with extra attributes for text areas

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		If greater than 0, represents roughly the number of rows of text displayed in the text area. Otherwise will be a set to sensible default.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

TextCell

top

A ListView cell with extra attributes for text field

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntries	Integer	-1	Integer that determines the max number of entries to show for a comma-separated text cell. Shows "..." at the end
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	java.lang.String	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

TextCellType

top

Subclasses:

TextAreaCell TextCell

TextInputBase

top

An Input with extra attributes for text fields

Subclasses:

NoteBodyInput PasswordInput PrivacyInput TextInput

TextInput

top

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
autoComplete	Expression (gw.api.contact.AutocompleteHandler)		Optional. Expression that returns an gw.api.contact.AutocompleteHandler which produces auto complete suggestions for this widget. USE WITH CAUTION: If specified, the handler will be called at server side on each user key stroke.
autoCompleteArgIds	String		An optional attribute to specify additional arguments to pass to the "autoComplete" handler, if exists. (You don't need to specify the id of this widget as part of this attribute, because the value of this widget is passed to the handler by default; If the id of this widget is specified, the argument value passed to the handler will be null, since the value of this widget has not been fully specified when the handler is invoked.) Refers to the "id" attribute of other value widget on page. Multiple ids can be separated by ",". If specified, the latest value of these widgets will be passed to the autoComplete handler when retrieving auto complete info.
autoCompleteTriggerChars	Integer		If specified, delays autocomplete functionality until the user has entered the specified number of characters.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableAutoCompleteMarkup	Boolean	false	If true, enables html markup in the autocomplete suggestions for this text input by means of the following special tags: [i]italic[/i] - makes text italic, [b]bold[/b] - makes text bold and [hl]highlighted[/hl] - highlights the text
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
format	Expression (String)		An optional expression that returns a format pattern, which must conform to the number format defined in java.text.DecimalFormat. When the underlying data type is not a Number, only the prefix and suffix of the pattern will be applied. For example, "#.#%" formats the Number value as percentage with up to 1 decimal digit.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
inputMask	Expression (String)		A gosu expression that returns a string to use as the input mask. If not specified, the input mask (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no mask or where the mask needs to be conditional. The input mask returned should be of the same format as a mask specified using the input-mask attribute on a field validator (use # for wildcards). A mask that contains no wildcards will just be used as a placeholder value. The input mask is recalculated on every render, which means that if the mask is conditional and dependent on other data on this page that it can change from one request to the next.
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
maxChars	Integer	0	The maximum number of characters allowed for an input field.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
regex	Expression (String)		A Gosu expression that returns a regular expression string to validate the user input. If not specified, the regular expression (if any) specified on the value's field validator will be used. This field should only be necessary in cases where the data type has no regular expression or where it needs to be conditional. The value returned should be of the same format as a regular expression specified on a field validator. This property is recalculated on every render, which means that if the regular expression is conditional and dependent on other data on this page that it can change from one request to the next.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
userInputRestriction	InputRestrictionType	defaultForType	If set to a type other than 'all', will prevent the user from inputting certain types of characters on the client on a per character basis. Defaults to 'defaultForType'. Can be used in conjunction with the Input Mask property. For instance, a US phone number client mask could be implemented by setting this property to 'numeric' and the input mask to '+1(###)###-####. Some value widgets, like passwords or dates, may modify or ignore this property. This property has no effect on server or database level validation of data or input; meaning, an authenticated user could choose to manually submit a form with invalid data that would bypass this check. For database level validation see the 'regex' property.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	java.lang.String	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

TileActionIterator

top

Iterates over items in the array referenced by "value" to create TileActions.

Child elements:

AbstractTileAction

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to list, an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.

TileAction

top

Can be used on the TileActions as a static Action widget or as part of TileActionIterator.

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (Object)		Label to render.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TileActions

top

Wrapper for TileActions. Can contain static TileActions or/and TileActionIterator to generate TileActions based on an array.

Child elements:

TileAction TileActionIterator

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
dropdownButtonLabel	Expression (String)		If there is two or more items defined in "Tile Actions " tab this label will be displayed on dropdown button. If value is not specified it will display "Actions" as label
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

TileChartPanel

top

A version of ChartPanel that can be used in a ChartTile.

Child elements:

Require Variable DomainAxis RangeAxis DataSeries DualAxisDataSeries Code

Attribute:	Type:	Default:	Description:
allowSeriesToggling	Boolean	true	If true, chart series' visibility can be toggled on and off by clicking on it or on the corresponding legend entry
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
displayLegend	Boolean	true	If true, displays a legend with a title for each data series. Default to true
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
type	ChartType		One of the enumerated chart types
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TileInputColumn

top

A single vertical column in the DetailViewTile. Similar to InputColumn, but with limitations on allowed content.

Child elements:

AbstractTileInput

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
labelWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. If defined, explicitly sets the label width for the tile input column.

TileInputSet

top

A reusable set of Tile Inputs

Child elements:

Require Variable Expose ExposeIterator ExposeRowTree ReferencedWidget AbstractTileInput TileInputSet Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

TileInputSetRef

top

Includes a TileInputSet by reference.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		The ID of the InputSet to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the panel will be loaded whose "mode" matches the evaluated "mode" of this element. If no panel is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

TileRef

top

Includes a Tile by reference.

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
def	Shared section reference		The ID of the Tile to include by reference.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

TitleBar

top

The optional top title bar of the screen, or of a panel within the screen. Normally not specified for a screen, therefore allow an implicit title bar to be generated for the screen based on the containing Page's title. If not specified for a panel, no implicit TitleBar will be generated.

Child elements:

Badge Link

Attribute:	Type:	Default:	Description:
action	Statement		Action to take when the title is clicked. If specified, the title will be clickable.
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
headingLevel	HeadingLevel	2	Changes the visual style for the heading level of the title bar. Defaults to 2. This property has no effect when the title bar is fixed to the top of the screen
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
subtitle	Expression (String)		If defined, will add a smaller sub-title after the title.
title	Expression (String)		The title text to show.
visible	Expression (Boolean)	true	Boolean expression which, if false, completely hides the widget and all its children
widgetOuterSpacing	WidgetSpacing	normal	"In general, determines the amount of spacing OUTSIDE of the Widget in all 4 directions: top, right, bottom, left. However, different Widgets may have requirements that prevent all 4 directions from being modified.
widgetStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Widget. In general, this refers to the background color and text color, but there are possible additions like cursor changes or filters.

ToolbarButton

top

A simple button in a toolbar.

Child elements:

StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		Action performed by this widget. By default, this is a Gosu expression. Other types of actions can be specified by using the following prefixes: http: causes the browser to follow the specified plain http link https: causes the browser to follow the specified plain https link javascript: causes the browser to execute the specified javascript logout: logs out of the application
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children and makes them unclickable
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		Confirmation message to show before performing the action
default	Boolean	false	If true, the button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
download	Download		Should be 'true', 'inline' or 'attachment' if the action taken by this widget is to download a file.
flags	String		A very special expression defining what flags (see ToolbarFlag) must be checked for the toolbar button to be available (= not grayed out). All processing of flags happens on the browser-side. The flags syntax is a comma-separated list of predicates (with no space after each comma), and all predicates must be satisfied for the button to be available. Each predicate consists of a operator followed by a space and then the name of a ToolbarFlag. For instance, flags="one Foo,no Bar" means "only available if there is exactly one Foo checkbox checked and no Bar checkboxes checked". The available operators are: one, two, any, all, no, exists (same as any).
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.
label	Expression (Object)		Label to render.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
promptDefault	Expression (String)		Default text answer to the prompt message
promptQuestion	Expression (String)		Question to ask the user before performing the action. The answer is exposed to the action as "web.WebUtil.ActionEventParameter".
retainScrollPosition	Boolean	false	If true, the page will scroll back to the original scroll position after the action. Should only be set if the action stays on the same page and the page layout does not change. Default to false
shortcut	String		Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
showConfirmMessage	Expression (Boolean)	true	Gosu expression which determines whether or not the confirmation message should be shown
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info if the user hovers the mouse over the button
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children

ToolbarButtonSet

top

The reusable definition of ToolbarButtons

Child elements:

Require Variable ReferencedIterator ReferencedRowTree AbstractToolbarButton ToolbarDivider EditButtons WizardButtons IteratorButtons TreeButtons ToolbarButtonSetRef Code

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.

ToolbarButtonSetRef

top

Includes a ToolbarButtonSet in a screen.

Child elements:

ToolbarButtonSet

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)		Boolean expression which, if false, makes this widget and all its children read-only
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterators	Iterator references		A comma separated list of iterators that are needed by the toolbar button set. They need to match up with the ReferencedIterators in the toolbar button set
mode	Expression (Object)		If you are including the ToolbarButtonSet by reference and you define a "mode" expression, then "mode" is evaluated and its result is converted to a String; the Def will be loaded whose "mode" matches the evaluated "mode" of this element. If no Def is found with a matching "mode", then the Def with mode="default" is used; if there is no default a runtime exception is thrown
toolbarButtonSet	Shared section reference		ID of the ToolbarButtonSet to include by reference (should only be used if you are not adding the def as a direct child of this element).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
widgets	Widget ids		A comma separated list of widgets that are needed by the section.

ToolbarDivider

top

Creates a divider inside a toolbar

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings

ToolbarFilter

top

A filter that operates on IteratorWidgets. Note that while this appears in the Toolbar,it is defined within the ListView.

Child elements:

ToolbarFilterOption ToolbarFilterOptionGroup

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
cacheKey	Expression (String)		By default, the selected filter option is cached in the user session, so that the selection will be remembered even after the user leaves the page and comes back. If this attribute is specified, the session cache will be ignored if the result of this expression changes since the last visit to this page.
cacheOptions	Expression (Boolean)	true	If true, only construct the filter options once when enter the page. Default to true. Be careful when you set this attribute to false, because it may slow down loading the containing page.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator widget this filter is applied to. Only applicable when this filter is not a direct child of an iterator widget.
label	Expression (Object)		Label to render.
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
name	String		Logical name of the filter. This isn't visible, but for caching you need to make sure each ToolbarFilter on the page is unique
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ToolbarFilterOptionGroup

top

A group of options within a ToolbarFilter

Attribute:	Type:	Default:	Description:
filterType	Type reference	gw.api.filters.IFilter	The type of the filter expression.
filters	Expression (context-dependent)		Expression that returns an array of filters. Each can be an already defined filter or a StandardQueryFilter or StandardBeanFilter.
visible	Expression (Boolean)		Boolean expression which, if false, hides this option

ToolbarFilterOption

top

An option within a ToolbarFilter

Attribute:	Type:	Default:	Description:
filter	Expression (context-dependent)		Expression for a filter. Use an existing filter, or define your own using StandardQueryFilter or StandardBeanFilter.When using custom backing data, Filters must be of the type that the custom backing data requires.
filterType	Type reference	gw.api.filters.IFilter	The type of the filter expression.
label	Expression (Object)		Expression for the display label of this option.
selectOnEnter	Expression (Boolean)		If true, this option will be the default option when no option has been selected
visible	Expression (Boolean)		Boolean expression which, if false, hides this option

ToolbarFlag

top

Not used in the Toolbar directly, but put in ListViews and other Iterators to flag whether a given ToolbarButton can be used to select that entry. See the SampleToolbarButtons.pcf file in the PX application for many examples.

Attribute:	Type:	Default:	Description:
condition	Expression (Boolean)	true	A boolean Expression. If it is defined the flag will be applied to the entry only if it evaluates to true.
name	String		The name of the flag, referred to by the "flags" attribute of ToolbarButton

ToolbarInput

top

An input in a toolbar

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
valueWidgetType	String	Text	The type of value widget to create for this input, such as Text or TypeKey.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

Toolbar

top

A horizontal bar containing buttons and other useful widgets. It can be used at the top of a Screen or before including a Panel.

Child elements:

AbstractToolbarButton ToolbarButtonSetRef ToolbarDivider ToolbarInput EditButtons WizardButtons IteratorButtons TreeButtons HiddenLink ToolbarFilter

Attribute:	Type:	Default:	Description:
allowTitlePlacement	Boolean	true	If true, and this Toolbar is a child of the Screen, this Toolbar will be placed in a fixed position next to the page Title. Defaults to true
id	String		Reference ID of the toolbar. This is optional, and does not have to be globally unique; it only has to be unique among the widget's siblings
maxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.

ToolbarRangeInput

top

A range input in a toolbar

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
newLabel	Expression (String)	DisplayKey.get("Java.NameValueView.New")	Label expression for the "New..." option. The default label defined for the application will be used if this attribute is not specified.
newValue	Expression (Object)		Value expression that returns a new instance for the input value. The "New..." option will be available when this attribute is specifed.
noneSelectedLabel	Expression (String)	DisplayKey.get("Java.NameValueView.NoneSelected")	Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
numRows	Integer		The number of rows to show in a multi-select input. This attribute is invalid on a single-select input.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionLabel	Expression (String)		Optional Gosu expression used to determine the label displayed for each element of the value range. Defaults to the element's display name or string representation if not present. The element value is exposed as "VALUE".
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
sortValueRange	Boolean	true	If true, attempts to sort the results of valueRange
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueRange	Expression (Object)		Gosu expression defining the range of possible values for this element. Should evaluate to a List, an array, or a IQueryBeanResult
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

TreeButtons

top

A set of pre-included toolbar buttons for tree table control, including "expand all" and "collapse all".

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
collapseLabel	Expression (String)		Alternative label for the collapse button
collapseShortcut	String	C	Keyboard shortcut character for collapse button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
collapseVisible	Expression (Boolean)		Boolean expression specifying whether the collapse button is visible.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
expandLabel	Expression (String)		Alternative label for the expand button
expandShortcut	String	A	Keyboard shortcut character for expand button, in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
expandVisible	Expression (Boolean)		Boolean expression specifying whether the expand button is visible.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
iterator	Iterator reference		The id of the iterator/list view widget this button applies to. If the value is a list view then the first iterator widget child is used.

TreeView

top

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
canClickElement	Expression (Boolean)		A Boolean expression, if false, disable clicking on a tree node. If not specified, a tree node is clickable if "onClickElement " is specified and permitted for that tree node.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
elementLabel	Expression (Object)		A Gosu expression that returns the label for each tree node. The model value of a tree node is exposed as a symbol with the name "elementName"
elementName	String		The model data of each tree node in the value result is exposed as a symbol with the name "elementName".
elementType	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
onClickElement	Statement		Action performed when clicking on a tree node. The model data of the tree node is exposed as "elementName"
preserveExpansionStateOnRefresh	Boolean	false	If true, whenever the value expression is evaluated and returns a new tree object then expand the same nodes in the new tree that were expanded in the previous tree, using the treeNode.DataKey property to match new and old nodes
selectElementOnEnter	Expression (Boolean)		A Boolean expression, if true, select the tree node when enter the page, as if the user has previously clicked on the node. This attribute will be ignored after the user actually clicks any tree node.
value	Expression (gw.api.tree.TreeNode)		A Gosu expression that evaluates to an instance of gw.api.tree.TreeNode

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
leftIndent	Boolean	false	If true, independent of 'panel inner spacing', the container will left indent its children by a fixed amount. This is useful for displaying nested data throughout a page. Purely a visual effect.
panelInnerSpacing	WidgetSpacing	none	In general, determines the amount of spacing INSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelOuterSpacing	WidgetSpacing	normal	In general, determines the amount of spacing OUTSIDE of the Panel in all 4 directions: top, right, bottom, left. However, different Panels may have requirements that prevent all 4 directions from being modified.
panelStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Panel. In general, this refers to the background color, but some styles can change other aspects such as font color, spacing, or filters.

TypeKeyCell

top

A ListView cell bound to a TypeKey value.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
hasColumnFilter	Boolean	false	If true, allow the user to filter the list based on any of the values in the column. Default to false.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
noneSelectedLabel	Expression (String)		Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference		The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

TypeKeyCheckBoxGroupInput

top

A TypeKey input bound to an array or list which renders as a group of checkboxes.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionIcon	Expression (String)		An optional expression to specify an icon for each option. The option value is exposed as "VALUE". The return value's type is determined by OPTION_ICON_TYPE
optionIconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. The option value is exposed as "VALUE". If not set will default to its font color.
optionIconType	IconTypeEnum		An enumeration of icon types that determine what the 'optionIcon' property on the widget is referring to.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

TypeKeyInput

top

An Input with extra attributes for a TypeKey field

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
noneSelectedLabel	Expression (String)		Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

TypeKeyRadioInput

top

A TypeKeyInput which renders as radio buttons.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
filter	Expression (context-dependent)		Optional Gosu expression for filtering the value range of the widget. You can write this either as a boolean expression over a "VALUE" symbol (i.e. "Libraries.MyLib.isOkValue(VALUE)"), or as a more complex expression that takes a "VALUES" array symbol and returns a List (i.e. "Libraries.MyLib.filterValues(VALUES)") which is more powerful and efficient but harder to write.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
noneSelectedLabel	Expression (String)		Label expression for the "none selected" option
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
optionIcon	Expression (String)		An optional expression to specify an icon for each option. The option value is exposed as "VALUE". The return value's type is determined by OPTION_ICON_TYPE
optionIconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. The option value is exposed as "VALUE". If not set will default to its font color.
optionIconType	IconTypeEnum		An enumeration of icon types that determine what the 'optionIcon' property on the widget is referring to.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
stacked	Expression (Boolean)	false	If true, the contents of the Widget will be stacked vertically.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference		The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

UserCell

top

A Cell that includes a drop-down list of users related to the current user, and a menu containing Select User and Search User items. The locations to which those items navigate are specified by the searchLocation and selectionLocation attributes.

Child elements:

Reflect ColumnFooter PostOnChange StandardMenuElement

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for details. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Specifies the alignment of this cell. Valid values: "left", "right", or "center". If no value is specified, the default alignment is determined by the value type ("center" for boolean values; "right" for numeric values; "left" for other value types).
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
bold	Boolean	false	If true, renders the cell contents in bold text. Defaults to false.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
colspan	Integer		The HTML colspan attribute, lets this cell span across multiple columns of other rows. Useful for generating a "group header" row above a RowIterator. The default value is 1. A value greater than 1 is only allowed when the containing row is not iterated by a RowIterator.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
enableSort	Boolean	true	If true, allows the user to sort the values in the column by clicking on the header. Only applicable when the containing row is iterated by a RowIterator.
endOfCellNav	Boolean	false	If true, this cell will the last cell in the row to be navigated to via the ENTER key. Only applicable when "CellNavOnEnter" or "QuickAddOnEnter" is set. Normally not specified. Default to false.
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
fontColor	Expression (Object)		An expression that returns a GWColor instance. Legacy: this method can instead return a string corresponding to a CSS Specification Level 3 color name. See GWColor for more details.
footerLabel	Expression (String)		An optional expression. If specified, a footer cell with the specified value will be rendered for this column. Only applicable when the containing Row is iterated by a RowIterator. Not allowed when "footerSumValue" is specified.
footerSumFormat	Expression (String)		An optional expression, if specified, will be used as format pattern for the footer sum value. Normally not specified, so that the "format" and\or "formatType" of the cell value will be applied to footer sum value. Only applicable when "footerSumValue" is specified. The result of this expression must conform to the number format defined in java.text.DecimalFormat.
footerSumValue	Expression (Object)		An optional Numeric expression. If specified, a footer cell that sums the specified value for all cells in this column will be rendered. Pagination of the list does not affect the sum value. Only applicable when the containing row is iterated by a RowIterator. Not allowed when "footerLabel" is specified.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
groupedOnEnter	Expression (Boolean)		If true, the ListView will be grouped by this cell upon entering the page. Only one grouped cell is allowed at any given time and it is only applicable when the column is sortable.
grow	Boolean	false	If true, this Cell and any other grow-enabled Cell will expand to fill remaining space in the ListViewPanel. Only applicable when the ListView is set to stretch.
hasCheckBox	Boolean	false	If true, generates a checkbox at the beginning of this cell. This checkbox can be used to check this entry in the nearest containing Iterator. Defaults to false. Only allowed if this cell is inside a CellIterator or under a Row inside a RowIterator.
height	String		CSS height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
icon	Expression (String)		Refers to an image file. If defined, makes this an icon cell. The "value" attribute should be a boolean expression describing whether the icon is visible in a given row.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconLabel	Expression (String)		The ALT text for any icon generated in the content cells
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		An optional expression. If specified, a header cell with the specified value will be rendered for this column. Only applicable when the containing row is iterated by a RowIterator.
labelStyleClass	String		Custom extension CSS style class to apply to the header.
maxHeight	String		CSS max-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
maxWidth	String		CSS max-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
minHeight	String		CSS min-height value. Can be `px` or `em`. If no suffix is provided, pixels are assumed.
minWidth	String		CSS min-width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
printWidth	String	1	Relative width when printing to PDF. All widths are relative to the widths of the other columns in the ListView
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)	pcf.UserSearchPopup.push()	The location of the user search item as a Gosu expression of the form "[location name].go()"
selectLocation	Expression (pcf.api.Location)	pcf.UserSelectPopup.push()	The location of the user select items as a Gosu expression of the form "[location name].go()"
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
showHeaderIcon	Boolean	true	If true, shows the icon defined by "icon" in the header cell for this column. The default value is true.
sortBy	String		An optional comma-separated sequence of Expressions, each of which is assumed to be a dot-delimited path, the value by which this column will be sorted if the user clicks on the header cell.
sortDirection	WidgetSortDirection	ascending	Either "ascending" or "descending"
sortOrder	Integer	0	The priority of sorting relative to other sorting elements like IteratorSort and Cell. The lower the number, the higher the priority. The highest priority is "1"
styleClass	LinkStyleClass		CSS style class for the cell content; for instance, "miniButton" makes a link appear as a small button
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
tooltip	Expression (String)		Extra "alt" text to show when the user hovers the mouse over the header cell of this column.
unique	Boolean	false	If true, validate before commit that the value of this column is unique across all rows in the current page. Only meaningful when this column is editable.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
validationLabel	Expression (String)		The label of this cell to be used when it has validation issues. Not needed when this cell has a "label". Required if the cell is editable but does not have a "label".
value	Expression (context-dependent)		The value this element binds to. If the element is editable then this value is both read from and written to (unless "setter" is defined).
valueType	Type reference	entity.User	The type of the value expression.
valueVisible	Expression (Boolean)		Boolean expression which, if false, hides the contents of the cell (its "ValueWidget"), but not the cell itself. Needed since hiding the actual cell usually screws up the layout
verticalAlign	WidgetVerticalAlignment		Specifies the vertical alignment of this cell. Valid values: "top", "middle", or "bottom". If no value is specified, the default alignment is determined by the cell type ("top" for Text Areas and Format Cells, "middle" for buttons and icons).
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
width	String		CSS width value. Can be `px`, or `em`. If no suffix is provided, pixels are assumed.
wrap	WrapType	default	If default, defers to FormatType to decide whether to wrap or not. If true, allows cell content to wrap.
wrapLabel	Boolean	false	If true, allows Header Cell text content to wrap. Defaults to true.

UserInput

top

An Input that includes a drop-down list of users related to the current user, and a menu containing Select User and Search User items. The locations to which those items navigate are specified by the searchLocation and selectionLocation attributes.

Child elements:

LayoutConfig Reflect StandardMenuElement PostOnChange

Attribute:	Type:	Default:	Description:
action	Statement		An optional action to take when the user clicks the value of this widget when the value is not being edited. See ActionBase for list of available action prefixes. When specified, the value of this widget will be rendered as a link when the value is not being edited.
actionAvailable	Expression (Boolean)		An optional boolean expression controlling whether the action should be available in this specific context when in read-only mode. This is ignored if in edit mode or if the action is null. This attribute will be deprecated in a future release, please use the 'available' attribute instead. To disable action in readonly mode, you can set available="CurrentLocation.InEditMode \|\| <action-available-condition>"
align	WidgetAlignment		Alignment of the widget ("left", "right", or "center")
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
available	Expression (Boolean)		Boolean expression which, if false, grays out the widget and all its children
boldLabel	Boolean	false	If true then the label is displayed in bold text.
boldValue	Boolean	false	If true then the value is displayed in bold text when read-only.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
confirmMessage	Expression (String)		The confirmation message to show when "showConfirmMessage" is set. If not specified, a standard message will be used.
conversionExpression	Expression (context-dependent)		A Gosu expression used to convert the value picked from a popup before set it into the model value of this widget. The picked value will be exposed as a symbol with the name "PickedValue"
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
editable	Expression (Boolean)	false	Boolean expression which, if false, makes this widget and all its children read-only
flatten	Boolean	false	If true, instead of showing a hierarchical menu, the widget will show a single menu with sub-menus grouped under headers.
focusOnStartEditing	Expression (Boolean)		An optional boolean expression, if returns true, this widget will get focus when start editing the containing location.
formatType	FormatType		How the value is formatted; options include "general", "currency", and "email". See the formatType enumeration.
helpText	Expression (String)		A Gosu expression which, if defined, is evaluated to create help info that guides the user to edit this widget. The help info will show up if the user hovers the mouse over or focuses on the widget, when the widget is in edit mode.
hideChildrenIfReadOnly	Boolean	true	If false, menu items under this input will be shown even when the input is not editable.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		Reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
inputConversion	Expression (Object)		A Gosu expression that converts the presentation value to a model value. The presentation value string is exposed to this expression as the symbol "VALUE".
label	Expression (Object)		Label to render.
labelAbove	Expression (Boolean)	false	Boolean expression which, if true, causes the label portion of the Input to be rendered above the value
labelStyleClass	String		Custom extension CSS style class to apply to the label.
numEntriesPerColumn	Integer	0	The number of child MenuItems to show in each column. If not specified, all children will be shown in a single column.
onPick	Statement		Gosu expression to be executed after the value is set from a picker.
outputConversion	Expression (String)		A Gosu expression that converts the model value to a presentation value. The model value is exposed to this expression as the symbol "VALUE". The return type of this expression must be String.
requestValidationExpression	Expression (Object)		A Gosu expression used to validate user value before setting it to the model. This expression can access any symbols available to this widget, and a "VALUE" symbol that represents the user value. If this expression returns null, the user value will be set into the model. Otherwise, an error message containing the result of the expression will be displayed on the page, the value will not be set into the model, and no actions can be performed until the error is corrected.
required	Expression (Boolean)		If true, then the cell must be filled out by the user
searchLocation	Expression (pcf.api.Location)	pcf.UserSearchPopup.push()	The location of the user search item as a Gosu expression of the form "[location name].go()"
selectLocation	Expression (pcf.api.Location)	pcf.UserSelectPopup.push()	The location of the user select items as a Gosu expression of the form "[location name].go()"
setter	Statement		!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * Deprecated. DO NOT USE. * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Consider using "onChange/onPick/inputConversion/outputConversion" where available. If specified and the Input is editable, then any new value of the Input is written to this expression (Gosu by default) instead of to "value". The new value is exposed as the symbol "VALUE". For instance if your value expression is "Foo.getSomething()" then it can't be written to since it's not an L-value; so you could specify a setter expression along the lines of "Foo.setSomething(VALUE)" Warning: if you use this attribute many pebbles features will not work, including but not limited to: * Correct automatic detection of the state of the updated data * Correct automatic detection of the editability of the data * Correct automatic detection of the maximum size of a text input
shortcut	String		Optional keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. This is only applicable when this widget has an "action" specified and the value is not being edited.
showConfirmMessage	Expression (Boolean)		Boolean expression which determines whether or not to show a confirmation message when the field value is changed directly from the UI. It's NOT applicable when the value is changed indirectly, for example, as a result of client reflection.
subMenuOnDemand	Boolean	false	An optional attribute, if set, defer sub menu generation until user tries to open the menu. DO NOT set this flag unless the sub menu of this widget is very expensive to generate. Setting this flag will reduce time to load the page, however require fetching additional info from server in the background, when the menu gets opened for the first time after page loaded.
validationExpression	Expression (Object)		A Gosu expression to run before committing the record. This expression can refer to any symbols available to this widget. If this expression returns null, the validation is considered successful; otherwise, the result of this expression will be displayed as an error and the record will not be committed.
value	Expression (context-dependent)		The value this Input binds to as an Expression. If the Input is editable then this value is both read from and written to (unless "setter" is defined).
valueSectionMaxWidth	String		CSS max-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionMinWidth	String		CSS min-width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueSectionWidth	String		CSS width value. Can be `px` or `em`. If no suffix is provided, pixels are assumed. Represents the width of the value portion of the label/value pair.
valueType	Type reference	entity.User	The type of the value expression.
visible	Expression (Boolean)		If used instead of "editable", specifies whether the Input is editable when data is being created

ValueCellType

top

Base type for all Cells that can be bound to a value.

Variable

top

Creates a new local variable with the same lifespan as the parent widget. This variable can be edited directly by value / input / cell widgets.

Attribute:	Type:	Default:	Description:
initialValue	Expression (context-dependent)		The initial value of the Variable, specified as a Gosu expression. If not specified, the initial value will be null.
name	String		The name by which the variable is exposed. The parent widget of this element and all its descendents will be able to refer to the symbol by this name. Note that Inputs and Cells can refer to "name" directly in their "value" expressions and even change the value of the variable.
recalculateOnRefresh	Boolean	false	If true, the value of the variable will be reset by calculating the initialValue expression, when the page is rerendered from the server. Default to false.
type	Type reference		The type of the symbol, such as "String" or "Policy".

Verbatim

top

A handy widget for displaying static text on the UI

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
border	Boolean	false	If true, the Widget will have a border around it. Purely a visual effect.
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
label	Expression (String)		Label to render.
labelStyleClass	String		Deprecated. Use widgetStyle.Custom extension CSS style class to apply to the label.
visible	Expression (Boolean)		Boolean expression which, if false, completely hides the widget and all its children
warning	Boolean	false	Deprecated. Use widgetStyle. If true, renders the message in a more visible "warning" style
widgetOuterSpacing	WidgetSpacing	normal	"In general, determines the amount of spacing OUTSIDE of the Widget in all 4 directions: top, right, bottom, left. However, different Widgets may have requirements that prevent all 4 directions from being modified.
widgetStyle	Expression (gw.api.web.WidgetStyleEnum)		The style of the Widget. In general, this refers to the background color and text color, but there are possible additions like cursor changes or filters.

WebMessageWorksheet

top

A special Worksheet to display runtime web messages. Do NOT modify.

Child elements:

LocationEntryPoint Scope Variable Screen ScreenRef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the location is canceled.
afterCommit	Statement		Gosu expression to run after the location is updated.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
alwaysInEditMode	Expression (Boolean)		If true the location will always go back to edit mode after a commit / cancel
beforeCancel	Statement		Gosu expressionto run when the location is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the location is updated but after the UI is validated.
beforeValidate	Statement		Gosu expression to run before the location is updated and before the UI is validated.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
closeOnLeaveScope	Boolean	false	An optional attribute, if true, this worksheet will be closed when leave the worksheet scope. Only applicable if it has no unsaved work. Default to false, so that the worksheet becomes hidden when out of scope, and reappears automatically when enter the scope again.
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this page. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". If not specified, validation issues on any entity that matches type of the "validationParameter" should be fixed on this page. This attribute is ignored if "validationParameter" is not defined.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
id	String		ID of this Location. Must be unique among all Locations.
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startEditing	Statement		Gosu expression to run when the location goes into edit mode.
startInEditMode	Expression (Boolean)	false	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it
tabLabel	Expression (String)		The label for the tab of this Worksheet in the Workspace
title	Expression (Object)		The title of the location. The title is shown in the top title bar, unless the Screen uses a special TitleBar element to override it.
validateOnBundleCommit	Boolean	true	If false, the page will disable the automatic validation that happens on every commit. Only set this attribute to false if you're really sure you know what you're doing.
validationParameter	String		The name of an argument on a LocationEntryPoint, used for fixing entity validation issues.

WidgetAlignment

top

Alignment of a widget

Value:	Description:
left
center
right

WidgetSortDirection

top

Sorting direction: ascending or descending

Value:	Description:
ascending	Ascending order, as in "A", "B", "C"
descending	Descending order, as in "C", "B", "A"

WidgetSpacing

top

Value:	Description:
large	The spacing will be larger than the standard spacing.
normal	The spacing will be standard for the theme.
none	The spacing will be as small as possible.

WidgetVerticalAlignment

top

Vertical alignment of a widget

Value:	Description:
top
middle
bottom

WizardButtons

top

A set of pre-included toolbar buttons for Wizard control. Gets its set of buttons from its containing wizard

Attribute:	Type:	Default:	Description:
ariaInfo	Expression (gw.api.web.aria.AriaInfo)		A gosu expression that returns an AriaInfo instance. Information on the object will be used to populate HTML Attributes relating to ARIA and will override widget defaults. Most widgets will have appropriate defaults, or will make use of existing properties to populate various ARIA values. Like 'help text' being used for aria-label, if aria-label is not specified via this info object.
cancelShortcut	String		Cancel keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
classList	String		A space delimited list of CSS class names to appear on the outermost HTML element of the component.
defaultButton	DefaultButtonType	next	This button is the default for the page, and will be "clicked" when the user presses Enter
desc	String		Use this to add your own comments to the widget. For now this attribute does nothing; later if we create a "UI dictionary" the description will show up there, much the way it does in the Data Dictionary.
finishShortcut	String		Finish keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit
hideIfEditable	Boolean	false	If true, makes the widget invisible if it is editable.
hideIfReadOnly	Boolean	false	If true, makes the widget invisible if it is not editable.
id	String		(Optional) reference ID of the widget. This does not have to be globally unique; it only has to be unique among the widget's siblings
pickValue	Expression (context-dependent)		The value returned from this location when update is clicked

Wizard

top

A Location with multiple Screens

Child elements:

LocationEntryPoint Variable AbstractWizardStepsRef AbstractWizardStepsDef Code

Attribute:	Type:	Default:	Description:
acceleratedMenuActions	Shared section reference		The ID of the AcceleratedMenuActions content for this location group. It will be inherited by all descendent Locations of this group by default. Normally not used, but use MenuActions instead.
afterCancel	Statement		Gosu expression to run after the Wizard is canceled. See ActionBase for kinds of available actions
afterFinish	Statement		Gosu expression to run after the user gets all the way through and finishes the Wizard.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
autosaveable	Boolean	true	If true, then the location will be saved in the auto-save cache when the user navigates out if (a) it is in edit mode, and (b) there is any unsaved data. The location is restored from the cache when the user returns to it
beforeCancel	Statement		Gosu expression to run when the Wizard is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the wizard state is persisted into database.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
cancelWarning	Expression (String)		Gosu expression that returns a message to display in a confirmation dialog when the user attempts to cancel this wizard
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
finishConfirmation	Expression (String)		If non-null, the string specified will be presented to the user as a confirmation message when they attempt to finish the wizard.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
id	String		ID of this Location. Must be unique among all Locations.
independentStepsTitle	Expression (String)		The optional title for menu links of independent steps.
independentStepsTitleIcon	Expression (String)		The optional title icon for menu links of independent steps.
independentStepsTitleIconType	IconTypeEnum		An enumeration of icon types that determine what the 'independentStepsTitleIcon' property on the widget is referring to.
infoBar	Shared section reference		ID of the InfoBar content for this location (just below the TabBar and above the main content)
inheritMenuLinks	Boolean	false	If true, this wizard will have no MenuLinks of its own, and will inherit MenuLinks from its ancestor location group (if any).
isDraftOnEnter	Expression (Boolean)		A boolean expression which, if true, means the wizard started from a previously saved draft, in which case the wizard does not appear as unsaved work on enter.
menuActions	Shared section reference		ID of the optional MenuActions content for this location (in the bottom of the left menu)
menuLinks	Shared section reference		Normally NOT specified, in which case default MenuLinks (in the left menu) are generated based on steps of this wizard.
menuTree	Shared section reference		ID of the optional MenuTree content for this location (in the left menu). This should only be used if the wizard is also overriding the menuLinks attribute
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
onResume	Statement		A Gosu expression to run when this location is resumed from the autosave cache.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startInEditMode	Expression (Boolean)	true	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it. Default to true for Wizard.
subtitle	Expression (String)		The optional sub title for this wizard. If specified, it will be displayed in the left nav bar above links to wizard steps.
tabBar	Shared section reference	TabBar()	ID of the TabBar content for this location group. Normally not specified since "TabBar()" is the default.
title	Expression (Object)		The optional title for this wizard. If specified, it will be displayed in the left nav bar above links to wizard steps.

WizardStepGroup

top

Groups child Steps together, and provides a group label

Child elements:

Require AbstractWizardStepsRef AbstractWizardStepsDef

Attribute:	Type:	Default:	Description:
collapseIfNotCurrent	Boolean	false	If true, this group is collapsed in the left nav menu when none of its child steps is the currently selected step. Default to false.
id	String		The reference ID of the group, which must be unique among all locations.
label	Expression (String)		label for this widget
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
shortcut	String		Optional Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. If specified, this will be used for the MenuLink generated for this WizardStepGroup.
visible	Expression (Boolean)	true	A boolean expression which indicates if this Step is visible at all in the Wizard

WizardStepGroupRef

top

Includes a globally-shared WizardStepGroup

Attribute:	Type:	Default:	Description:
def	Shared section reference		ID of the group to include by reference
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the path will be loaded whose "mode" matches the evaluated "mode" of this element. If no path is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown

WizardStepIterator

top

Iterates over an array to create multiple steps in the wizard

Child elements:

AbstractWizardStepsRef

Attribute:	Type:	Default:	Description:
elementName	String		As each element in the array result of "value" is displayed, it is exposed as a symbol with the name "elementName", which the contents of this iterator can refer to
type	Type reference		Lets you manually specify the type of element exposed as "elementName". This is useful if you have special knowledge about the type of element returned by "value": for example, if the field referred to returns an array of Contacts but you happen to know that they are guaranteed to all be Persons
value	Expression (context-dependent)		A Gosu expression that evaluates to the elements over which to iterate. Must evaluate to an Object array or a IQueryBeanResult.
valueType	Type reference		The type of the value expression.

WizardStep

top

Defines one step in a Wizard.

Child elements:

NextCondition SkipButton

Attribute:	Type:	Default:	Description:
allowFinish	Expression (Boolean)		Gosu expression indicating whether or not the finish button is available. If not specified, then the finish button will be available if this is the last step in the wizard.
allowNext	Expression (Boolean)		Gosu expression indicating whether or not the next button is available. If not specified, then the next button will be available unless this is the last step in the wizard.
available	Expression (Boolean)	true	A boolean expression which, if false, grays the step out and won't let the user visit it (as opposed to visible/canVisit, which hide the step completely)
beforeSave	Statement		Gosu expression to execute before save this step. Only applicable when "save" returns true.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this Step. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". And the corresponding validation issue is exposed as "ISSUE"
icon	Expression (String)		The name of a .png file, or .svg file, or font glyph. The Widget's iconType determines which one.
iconColor	Expression (gw.api.web.color.GWColor)		Color of the icon. If not set will default to its font color.
iconType	IconTypeEnum		An enumeration of icon types that determine what the 'icon' property on the widget is referring to.
id	String		The reference ID of the step, which must be unique among all locations. This ID is used for a lot of purposes; most importantly it is what you refer to in the "go" action
independent	Boolean	false	If true, the step is displayed at the bottom of the wizard, and is separated from ordinary wizard navigation; in particular, it is not affected by the high water mark.
label	Expression (String)		The label for this step in the wizard menu links. If unspecified, the "title" attribute is used as the default.
minimizedLabel	Expression (String)		If this Widget can be placed in a minimized state, this minimizedLabel text will be used. Otherwise, the Widget will use its global shortcut key, or icon if available.
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the screen will be loaded whose "mode" matches the evaluated "mode" of this element. If no screen is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown
onEnter	Statement		Gosu expression to execute when entering this step every time.
onExit	Statement		Gosu expression to run when leaving this step to move forward in the wizard or when finishing on this step.
onFirstEnter	Statement		Gosu expression to execute when entering this step for the first time.
refreshStepsOnExit	Boolean	false	If true, refreshes the steps in the wizard when leaving this step. Should only be set to true on steps that allow the editing of some value that could affect a WizardStepIterator defined in this wizard
save	Expression (Boolean)	false	If true, a draft will be saved whenever we exit this step
screen	Shared section reference		The ID of the Screen for this step.
shortcut	String		Optional Keyboard shortcut character in the form of "Q" or "ShiftQ"; the "Alt" key is implicit. If specified, this will be used for the MenuLink generated for this WizardStep.
showNextIfLastStep	Boolean	false	If true, the next button will always be shown, regardless of whether or not the wizard thinks it has more steps.
title	Expression (String)		The title for this step
visible	Expression (Boolean)	true	A boolean expression which indicates if this Step is visible at all in the Wizard

WizardStepSet

top

A group of wizard steps

Child elements:

Require AbstractWizardStepsRef AbstractWizardStepsDef

Attribute:	Type:	Default:	Description:
available	Expression (Boolean)	true	A boolean expression which, if false, grays the step out and won't let the user visit it (as opposed to visible/canVisit, which hide the step completely)
id	String		The reference ID of the group, which must be unique among all locations.
mode	String		An optional String which, if specified, means that any element dynamically including this widget must specify the same mode. There is also a special mode "default" you can use which means "Use this widget if no widget with the specified mode exists". You can also have this widget match more than one mode by separating mode strings with a \| character.
visible	Expression (Boolean)	true	A boolean expression which indicates if this Step is visible at all in the Wizard

WizardStepSetRef

top

Includes a globally-shared wizard path by ID and, optionally, mode

Attribute:	Type:	Default:	Description:
def	Shared section reference		ID of the group to include by reference
mode	Expression (Object)		If defined, "mode" is evaluated and its result is converted to a String; the path will be loaded whose "mode" matches the evaluated "mode" of this element. If no path is found with a matching "mode", then the panel with mode="default" is used; if there is no default a runtime exception is thrown

Worksheet

top

A special Page that goes in the Workspace. A worksheet will only be visible when it's "in scope". Use the scope element to specify the scope of this worksheet.

Child elements:

LocationEntryPoint Scope Variable Screen ScreenRef Code

Attribute:	Type:	Default:	Description:
afterCancel	Statement		Gosu expression to run after the location is canceled.
afterCommit	Statement		Gosu expression to run after the location is updated.
afterReturnFromPopup	Statement		Gosu expression to run after return to this page from a popup. Whether the popup was committed is exposed as a symbol with the name "committed".
alwaysInEditMode	Expression (Boolean)		If true the location will always go back to edit mode after a commit / cancel
beforeCancel	Statement		Gosu expressionto run when the location is canceled but before the rest of the cancel completes.
beforeCommit	Statement		Gosu expression to run before the location is updated but after the UI is validated.
beforeValidate	Statement		Gosu expression to run before the location is updated and before the UI is validated.
canEdit	Expression (Boolean)		A boolean expression which, if false, prevents the user from putting the location into edit mode
canVisit	Expression (Boolean)		A boolean expression which, if false, means the user has no permission to visit the location, and links to the location will be either invisible or grayed out, depending on context.
closeOnLeaveScope	Boolean	false	An optional attribute, if true, this worksheet will be closed when leave the worksheet scope. Only applicable if it has no unsaved work. Default to false, so that the worksheet becomes hidden when out of scope, and reappears automatically when enter the scope again.
countsAsWork	Boolean	true	If false, the location can still be kept in the autosave cache, but does not appear as unsaved work to the user (with link highlighting etc.).
desc	String		Use this to add your own comments to this element. For now this attribute does nothing; later if we create a "UI dictionary" or PCF editor, the description will show up there.
handlesValidationIssue	Expression (Boolean)		An optional boolean expression, if specified, determines whether validation issues on a particular entity should be fixed on this page. The entity instance with validation issues is exposed to this expression as "VALUE". For example, "VALUE typeis entity.MyBean". If not specified, validation issues on any entity that matches type of the "validationParameter" should be fixed on this page. This attribute is ignored if "validationParameter" is not defined.
highlightChangedValues	Boolean	true	If true then changed inputs and cells in this location will be highlighted.
id	String		ID of this Location. Must be unique among all Locations.
onConcurrentDataChange	Statement		This expression, when specified, appends a link to the concurrent data change error message. The text of the link will be the value of the display key Java.Message.ConcurrentDataChange.Link. Clicking on the link will execute the given expression. A concurrent data change error happens if a user's changes cannot be committed because they clash with concurrent changes by a different user.
parent	Location reference		Reference to the "parent location" of this location, to specifiy the hierarchy of pcf locations. Used for the automatically generated "up link" in the title bar, highlighting of current menu links, and grouping items under "Unsaved Work". Usually the parent is the location right above this location in the application hierarchy, i.e. the parent of "ActivityDetailWorksheet" is "ClaimWorkplan", the parent of "Desktop Activities" is "Desktop" and "Desktop" has no parent at all.
showUpLink	Boolean	false	If true, creates an "up link" icon in the title bar that links to the parent location. The upLink will pop the current location off the stack if the parent location is in the stack; otherwise, the upLink will "go" to the parent location, passing all of the symbols from the current page in a manner consistent with the "go" action.
startEditing	Statement		Gosu expression to run when the location goes into edit mode.
startInEditMode	Expression (Boolean)	false	Boolean expression which, if true, puts the location in edit mode as soon as the user enters it
tabLabel	Expression (String)		The label for the tab of this Worksheet in the Workspace
title	Expression (Object)		The title of the location. The title is shown in the top title bar, unless the Screen uses a special TitleBar element to override it.
validateOnBundleCommit	Boolean	true	If false, the page will disable the automatic validation that happens on every commit. Only set this attribute to false if you're really sure you know what you're doing.
validationParameter	String		The name of an argument on a LocationEntryPoint, used for fixing entity validation issues.

WrapType

top

Wrap types

Value:	Description:
default	Default value defers to format type to determine whether to wrap or not
true	Wrap contents
false	Do not wrap contents