|
|||||||||
PREV NEXT | FRAMES NO FRAMES |
FormItem.addChangedHandler(com.smartgwt.client.widgets.form.fields.events.ChangedHandler)
handler
specified on the ListGridField will be passed onto the editors for this field.
FormItem.addChangeHandler(com.smartgwt.client.widgets.form.fields.events.ChangeHandler)
handler
specified on the ListGridField will be passed onto the editors for this field.
canCloseTabs
is set, this notification method fired when the user clicks
the "close" icon for a tab.
Return false to cancel default behavior of removing the tab from the TabSet
doubleClickDelay
by default) in this object.
com.smartgwt.client.widgets.tree.TreeGrid#closeFolder
.
com.smartgwt.client.widgets.tree.TreeGrid#folderDrop
processing occurs
and returning false will suppress that default behavior.
com.smartgwt.client.widgets.tree.TreeGrid#openFolder
.
iconClick
method will
be fired instead (if specified).
DynamicForm.submitForm()
a form is unable to
submit to the server.
com.smartgwt.client..FormulaBuilder
to create a new Formula Field.
RPCResponse.STATUS_SUCCESS
.
canHover
is true for this widget, the hover
string method will be fired when the user
hovers over this canvas.
'showHover'
is true for this canvas, this notification method
will be fired whenever the hover shown in response to Canvas.handleHover()
is hidden.
'icon'
, a separate click handler for the
icon may be defined as this.iconClick
.
canFocus
:
true).
canFocus
: true).
mouseStillDownDelay
by
default) when the system is idle - i.e.
TreeGrid.addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler)
instead.
saveOnEnter
is set and the user presses Enter whilst in a text-item in any clause or subclause.
com.smartgwt.client..SummaryBuilder
to create a new Summary Field.
icon
.
<TEXTAREA>
object) automatically expands to
accomodate its contentcom.smartgwt.client.rpc.RPCManager#handleError
dragTarget
or outline.
dragTarget
(or outline) back to its
original location or true to leave it at the current cursor position.
dragTarget
or outline.
dragTarget
(or outline) back to its
original size or true to leave it at the current cursor position.
'name'
field of this
grid's data tree.
FormItem.clearValue()
if
appropriate.
Canvas.showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
to determine the masks
behavior
when clicked.ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
ListGrid.expandRecord(com.smartgwt.client.widgets.grid.ListGridRecord)
.
Tree
class, which manipulates hierarchical data sets
the TreeGrid widget class, which extends the ListGrid class to visually present tree data in an
expandable/collapsible format.DataSource#compareCriteria
to determine whether new
criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more restrictive, returning
1, 0 or -1 respectively.
DataSource#compareCriteria
to determine whether new
criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more restrictive, returning
1, 0 or -1 respectively.
substring
.ControlNames
are strings used to specify which UI controls should appear
in the editor
toolbar.SimpleType
.workdays
, and returns true if found.
FieldType
.defaultValue
when no value is provided for this item.
defaultValue
when no value is provided for this item.
HandlerRegistration
.Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#deselectValue
implementation on this items freeform
text entry field.
useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#deselectValue
implementation on this items freeform
text entry field.
DetailViewer
.DetailViewer
.
Window
used for small windows such as alerts,
prompts, and confirmations.ListGrid.startEditingNew()
for example), which has not yet been saved, this method will
remove the row entirely.
ListGrid.startEditingNew()
for example), which has not yet been saved, this method will
remove the row entirely.
HandlerManager
.
DataSource.fetchData()
is called).
data
is
sent
to the dataURL
.'DataSource operation'
.DSRequest
.ListGrid
).
hilites
hilites
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
'DataSource'
to retrieve data that matches the current filter and sort criteria for this component, then exports the
resulting data to a file or window in the requested format.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
'databound components'
understand and treat specially (using type-specific form controls, validators,
formatters, sorting
logic, etc).showFilterEditor
) is visible
for this grid, this method will perform a filter based on the current values in the editor.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
TileLayout
, but by default lays out tiles in 'flow' mode instead
of 'fit' mode.showFilterEditor
) is visible
for this grid, this method will explictly put focus into the specified field in the filter editor.
showFilterEditor
) is visible
for this grid, this method will explictly put focus into the specified field in the filter editor.
type
property of the
field.DataSource.getDataSource(java.lang.String)
: Lookup a DataSource by ID.
baseStyle
for all cells
for this particular record.
edgeStyleName
will be treated as a
base style name and appended with following suffixes to support separate styling per cell:
'add event'
toolbar button
dataSource
.
DataSource
s that have
a 'primaryKey'
, and all primary key values are present in
the request.
alternateRecordStyles
is true for this grid.
alternateWeekStyles
.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
canRemoveRecords
is enabled, should records
be animated out of view when they are removed by the user?
'animating record removal'
, this property
designates the speed of the animation in pixels per second.
'(see
animateRemoveRecord)'
, if animateRemoveSpeed
is not set, this property designates the duration of the animation in ms.
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?
Page.getAppImgDir()
.
autoPosition
is false, this property controls
whether to automatically center the colorPicker every time it is reshown with the show() method.
tableName
.
'field.name'
for
any field that does not have a 'field.title'
and is not
marked 'hidden'
:true, by calling the method com.smartgwt.client.data.DataSource#getAutoTitle
.
DataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
depending on
DataBoundComponent.getAutoFetchAsFilter()
.
dataSource
, should options be fetched from the server when
the item is first written out, or should this fetch be delayed until the user opens the pickList.
dataSource
, should options be fetched from the server when
the item is first drawn, or should this fetch be delayed until the user opens the pickList.
optionDataSource
is
specified, a valueMap will be automatically created by making a DataSource.fetchData()
call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and
valueField.
optionDataSource
.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial Calendar.fetchData()
call.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial DynamicForm.fetchData()
call.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial ColumnTree.fetchData()
call.
autoFetchData
, or filtered by the user via the 'filterEditor'
, this attribute can be used to set the textMatchStyle
on the dsRequest passed to
fetchData()
.
autoFetchData
is true
, this attribute
allows the developer to specify a textMatchStyle for the initial TileGrid.fetchData()
call.
autoFetchTextMatchStyle:"exact"
.
autoFitData
is set to "vertical"
or
"both"
this property specifies the number of additional records for which the grid will expeand.
autoFitData
is set to "horizontal"
or
"both"
this property provides the maximum number of columns for which the ListGrid will expand.
autoFitData
is set to "vertical"
or
"both"
this property provides an upper limit on how far the ListGrid will expand vertically to accomodate
its content.
autoFitData
is set to "vertical"
or
"both"
this property provides the maximum number of records for which the ListGrid will expand.
autoFitData
is set to "horizontal"
or
"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accomodate
its content.
dynamicForm.focusInItem(itemName)
Tree.setRoot(com.smartgwt.client.widgets.tree.TreeNode)
is called.
saveByCell
is true).
LayoutPolicy
is "flow", should we automatically start a new line when there's not
enough room to fit the next tile on the same line?
baseStyle
will be applied to the button.
baseStyle
To override the baseStyle at the row level, use
'record[listGrid.recordBaseStyleProperty]'
instead.
'serverType'
:
booleanTrueImage
and the booleanFalseImage
Note: If booleanTrueImage
is unset, the checkedImage
will be used to indicate a true value
in a boolean field.
booleanTrueImage
and booleanFalseImage
.
'ID'
.
RPCTransport
transport, this attribute
specifies the name
of the URL parameter which is used to specify the callback function that
the server is expected to call by writing
out JavaScript code.
false
, other records cannot be dropped on (i.e., inserted via drag and drop) immediately before
this record.
treeNode
s) may be dropped over this node.
com.smartgwt.client..FormulaBuilder
.
com.smartgwt.client..SummaryBuilder
.
this.confirmCancelEditing
is true this property is used as the message
to display in the confirmation dismissal prompt.
DynamicForm.cancel()
DynamicForm.cancel()
'target'
, hiding it and shifting the Splitbar and other members of the
layout across to fill the newly available space.
'target'
, hiding it and shifting the Splitbar and other members of the
layout across to fill the newly available space.
false
, this record cannot be dragged.
canDrag
set to true to allow dragging of the split bar.
canDrag
set to true to allow dragging of the split bar.
CalendarEvent
that determines editability.
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.
'selectionAppearance'
set to "checkbox"
com.smartgwt.client..ValueMap
field to be edited without going into edit mode.
align
.
FormItem.setValue(int)
.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for an unselected row.
selectionAppearance
is set to
"checkbox"
this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected.
selectionAppearance
is set to
"checkbox"
this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for a selected row.
ExpansionMode
that show another grid or tree, what the child's expansionMode
should be.
childrenProperty
directly on
the childrenField object.
'multiple:"true"'
, controls the name of
the XML tag used for each subelement during DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
'headerContextMenu'
for
this grid, and a 'filter-editor'
is visible, this
attribute will be shown as the menu item title to clear any existing filter.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
clientOnly
DataSource.
folderIcon
for
closed folders.
folderIcon
for
closed folders.
canCloseTabs
is true.
canCloseTabs
is true.
Tab
key.
DataBoundComponent
, the ID
of the submitting component.
this.confirmDiscardEdits
is true, this property can be used to customize the error message string
displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to
sort/filter actions that would otherwise drop unsaved edit values.
showConnectors
is true.
'Relogin'
, this property marks this request an attempt to login,
therefore a response containing the loginRequiredMarker
is a normal condition and should result in the
status code RPCResponse.STATUS_LOGIN_INCORRECT
rather than a call to com.smartgwt.client.rpc.RPCManager#loginRequired
.
contentsURL
is assumed to be an HTML fragment rather than a
complete page.
src
specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment.
httpMethod
is set to "POST".
btnSize
.
operator
, the name of the DataSource
field for the ${isc.DocUtils.linkForRef('object:Criterion')} this FormItem generates.
ResultSet
cache should be dropped when the criteria
changes.
Criteria
changes.
DynamicForm.getValuesAsCriteria()
.
'default node.showDropIcon'
property.
'default node.showOpenIcon'
property.
'default node.showOpenIcon'
property.
'default
node.icon'
property.
Tree
object consisting of nested TreeNode
s to display in this ColumnTree.
Tree
object containing of nested TreeNode
s to display as rows in this TreeGrid.
RecordList
.
DataSource.fetchData()
is called).
DataSource
is this resultSet associated with?
DSRequest
.
DSRequest
.
DSRequest
.
DSRequest
.
'date picker'
toolbar button
'Smart GWT SQL engine'
for persistence, which
database configuration to use.
'field.groupingMode'
is unset.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to
the height of the header when minimized.
titleProperty
value or
a nameProperty
value.
CalendarEvent
The name of this
field within the CalendarEvent can be changed via descriptionField
CalendarEvent
.
true
, the BaseWidget.destroy()
method has been
called on this canvas.
BaseWidget.destroy()
method is called on a widget.
BaseWidget.destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab(int)
}.
DataBoundComponent
.
recordDetailDSProperty
.
'canExpandRecords'
is true
and ExpansionMode
is detailField
.
confirmDiscardEdits
is true this is the
title for the save button appearing in the lost edits confirmation dialog.
'modelType:"parent"'
, should nodes in the
data array for the tree be dropped if they have an explicitly specified value for the parentIdField
which doesn't match any other nodes in the tree.
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.optionDataSource
field used to
retrieve the display values that are to be mapped from the internal values specified by valueField
.
displayField
for this form item.
displayField
for this form item.
displayField
for this form
item.
displayField
for this form item.
useTextField
is true
this
property can be used to customize the format in which dates are displayed.DateDisplayFormat
or a function which will return a formatted date string.
DateDisplayFormat
or a function which will return a formatted date time string.
"target"
, this value specifies the opacity to render the target while it
is being dragged.
ListGrid.getTitleField()
) for
the record(s) being dragged (including any icons / custom formatting / styling, etc).
ListGrid.getTitleField()
) for
the record(s) being dragged (including any icons / custom formatting / styling, etc).
drawAllMaxCells
cells to be rendered, the full dataset will
instead be drawn even if 'showAllRecords'
is false
and the viewport size and drawAheadRatio
setting
would normally have caused incremental rendering to be used.
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user
drop-hovers over some folder.
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user drop-hovers
over some folder.
canDropComponents
is set to true
.
addDropValues
is true and both
the source and target widgets are databound, either to the same DataSource or
to different DataSources that are related via a foreign key, this object
provides the "drop values" that SmartGWT will apply to the dropped object
before updating it.
preventDuplicates
is enabled.
ListGridEditEvent
for options.
this.editFailedCSSText
this.editFailedBaseStyle
instead.
iconHeight
.iconHeight
instead.
iconWidth
.iconWidth
instead.
imageURLPrefix
to the editor in question.
imageURLSuffix
to the editor in question.
this.editPendingBaseStyle
instead.
emptyMessage
if
displayed.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
CalendarEvent
The name of
this field within the CalendarEvent can be changed via endDateField
CalendarEvent
.
fixedRecordHeights
is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers.
enterKeyEditAction
as
specified at the listGrid level while focus is in this field.
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.showInlineErrors
and showErrorText
are both true and errorOrientation
is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accomodate the error message and icon.
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.escapeKeyEditAction
as
specified at the listGrid level while focus is in this field.
serverOutputAsString
except
the resulting String
is automatically evaluated as JavaScript.
evalScriptBlocks
is true, HTMLFlow will pre-process the loaded HTML in order to mimic how the HTML would
execute if it were loaded as an independent page or loaded via an IFRAME.
eventAutoArrange
is true, setting
eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified
by eventOverlapPercent
.
timelineView
eventWindowStyle
for an individual CalendarEvent
.
LayoutPolicy
:"fit", should margins be expanded so that tiles fill the available
space in the TileLayout on the breadth axis? This can also affect tileWidth
or tileHeight
.
ExpansionMode
that show another grid or tree, is that component editable?
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for collapsed rows.
canExpandRecords
is set to true
,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for expanded rows.
ExpansionMode
for records in this grid.
exportFilename
and
exportAs
respectively.
exportFilename
and
exportAs
respectively.
showFilterEditor
is true), and we're re-filtering on every keypress (filterOnKeypress
is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off.
displayField
is specified for this item,
should the item perform a fetch on the optionDataSource
to retrieve the display value for the item when FormItem.setValue(int)
is called with a value for which we do not already have a
mapped display value?
String
object.
String
object.
'headerContextMenu'
for
this grid, and 'this.canPickFields'
is true, this
attribute will be shown as the title for the menu item which contains a submenu with items allowing the user to show
and hide fields in the grid.
showFilterEditor
is true, this method will return the criteria currently displayed in the filterEditor
.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
optionDataSource
, displayField
and fetchMissingValues
), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch
the entire set of options from the server, and use these values to map the item value to the appropriate display
value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
ComboBoxItem.getPickListFilterCriteria()
.
showHeaders
is set
(the remaining columns have their titles derived from the item selected in the column to the left).
DynamicForm.submitForm()
a form
is unable to submit to the server.
canAddFormulaFields
.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze a currently unfrozen field.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
com.smartgwt.client..dataPath
for this canvas.
showGridSummary
is true
this
method is called for each field which will show a grid summary value (as described in showGridSummary
to get the summary value to display
below the relevant column.
showGridSummary
is true, this attribute will be
set to true on the record object representing the grid summary row.
gripImgSuffix
to simplify providing custom
grip media for this widget.
showGrip
is true
ComponentSchema
, indicates what group to place the property in when editing
in Visual Builder.
'headerContextMenu'
for
this grid and 'this.canGroupBy'
is true, this string
will be shown as the title for the menu item to toggle the group by setting for a field.
'grouping
modes'
, the current grouping mode.
showGroupSummary
is true, this attribute will
be set to true on each record object representing a group-level summary row.
customStyle
for the group-level summary row
displayed when showGroupSummary
is true.
GroupTitleRenderer.getGroupTitle(Object, GroupNode, ListGridField, String, ListGrid)
GroupValueFunction.getGroupValue(Object, ListGridRecord, ListGridField, String, ListGrid)
baseStyle
to apply to the buttons in the header, and the sorter,
for this ListGrid.
headerBaseStyle
.headerTitleStyle
as well.
showHeaderMenuButton
is true, this property
governs the height of the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the auto-generated headerMenuButton
'headerSpan'
with no height
specified.
showHeaderBackground
is true
, this
property provides the URL of the background image for the header.
titleStyle
to apply to the buttons in the header, and
the sorter, for this ListGrid.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass thereof.
type
: "separator"
, this attribute
specifies the height of the separator.
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.'accessKey'
, underline it in
the title of the button by default
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.showHeaderBackground
is true, this governs the URL
of the image to use in the header's highlighted state when the window is Window.flash()
this.showHover
is true, this property can be used to customize the alignment of content in the hover
canvas.
this.canHover
is true, how long should the mouse be kept over this widget before the hover event is
fired
this.form.itemHoverDelay
will be used instead.
this.showHover
is true, this property can be used to customize the height of the hover canvas shown.
this.showHover
is true, when the user holds the mouse over this Canvas for long enough to trigger a
hover event, a hover canvas is shown by default.
this.showHover
is true, should this widget's hover canvas be moved with the mouse while visible?
this.showHover
is true, should the hover canvas be shown with opacity other than 100?
this.showHover
is true, this property can be used to specify the css style to apply to the hover canvas.
this.showHover
is true, this property can be used to customize the vertical alignment of content in the
hover canvas.
'this.showHover'
is true, this property can be used to
customize the width of the hover canvas shown.
this.showHover
is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps.
vertical
is false, and src
is unset.
vertical
is false and src
is unset.
vertical
is false and src
is unset.
htmlElement
is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement
in the DOM.
xmlHttpRequest
transport) contains the HTTP response code sent
by the server.
FieldType
:"image" as the field to use when rendering a record as
an image, for example, in a TileGrid
.
icon
is specified, this property can be used to
specify the height of the icon to be displayed in the ListGrid header button.
"left"
and "right"
.
"left"
or "right"
"left"
and "right"
.
"left"
and "right"
.
"left"
and "right"
.
"left"
and "right"
.
icon
is specified, this property can be used to
specify the size of the icon to be displayed in the ListGrid header button.
iconVAlign
.
icon
is specified, this property can be used to
specify the width of the icon to be displayed in the ListGrid header button.
TreeNode
that holds an id for the node which is
unique across the entire Tree.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
valueIcons
when determining the URL for the image.
ListGridFieldType
] set to "image"
and the URL for
the image displayed is not absolute, the path of the URL will be relative to this stringvalueIcons
when determining the URL for the image.
"image"
and the URL for the image displayed is not absolute, the path of the
URL will be relative to this stringvalueIcons
when
determining the URL for the image.
valueIcons
) or this is has ListGridFieldType
set to "image"
, this the value of this property will be
appended to the end of the URL for the icon displayed.".gif"
to the filename of the image.imageURLSuffix
.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
ComponentSchema
, a field 'inherited'
from another schema can be redeclared with this
property set in order to indicate that the property should not be used.
'summary row'
for this grid.
'grid summary'
.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
useTextField
is true
this
property can be used to specify the input format for date strings.
useTextField
is true
this
property can be used to specify the input format for date strings.
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.
showGridSummary
, showGroupSummary
or ListGridFieldType
), and the summary function returns "null"
(implying it was
unable to calculate a valid summary value).
showGridSummary
is true.
showGroupSummary
is true.
canRemoveRecords
is true, this
field will be rendered as the remove-field for this grid.
true
, defines a horizontal separator in the
listGrid object.
true
, this menu item shows a horizontal separator instead of the title
text.
record[this.isSeparatorProperty]
is set for some record, the record will be displayed as a simple
separator row.
FormItem
from this ValuesManager.
javaClass
specifies the fully qualified Java className to be created and passed to the setter for the Java
Bean Property with the same name as this field.
javaClass
- when auto-populating of Java Beans / POJOs
based on inbound DSRequest data, for a field of type Collection or Map, javaCollectionClass
can be used
to specify a particular concrete class to use.
javaClass
- when auto-populating of Java Beans / POJOs
based on inbound DSRequest data, for a field of Map type, javaKeyClass
can be used to specify a particular
concrete class for the map keys.
recordXPath
mapping to the data node of json returned by the server.
Applies if this.dataFormat is set
to "json"
"A"
, "Enter"
)
"A"
, "Enter"
)
"A"
, "Enter"
)
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see 'form layout overview'
).
CalendarEvent
.
position
property).
position
property).
contentsURL
property has been set.
loadingMessage
.
this.longTextEditorType
(a TextAreaItem by default), rather than a simple
text item.
length
exceeds this
value, the ListGrid shows an edit field of type longTextEditorType
rather than the standard text field when the field enters inline edit mode.
length
exceeds
this.longTextEditorThreshold
show an edit field of this type rather than the standard text field when the
field enters inline edit mode.
layoutMargin
.
htmlElement
is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?FieldType
), this sets the maximum file size allowed, in bytes.
managePercentBreadth
:true.
MenuButton
generated for it automatically (for example
when included in a MenuBar
, the width that the MenuButton should have.
sendMetaData
is true, this attribute is used to
specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server.
canvas.animationTime
.
'field.name'
.
CalendarEvent
The name of this field
within the CalendarEvent can be changed via nameField
CalendarEvent
.
TreeNode
that holds a name for the node that is
unique among it's immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file
system.
icon.neverDisable
is true, when this form item is disabled, the icon will remain enabled.
ResultSet.setCriteria(com.smartgwt.client.data.Criteria)
are applied to it, and it may disappear from the cache.
'next'
toolbar button
update
or remove
operation, the original values from the record that is being updated
or removed.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
Tree.isOpen(com.smartgwt.client.widgets.tree.TreeNode)
to
determine if the node is open or not.
String
object.TreeGrid.setOpenState(java.lang.String)
to open the same set of folders within
the treeGrid's data (assuming the nodes are still present in the data).
operator
has been set for any FormItem
in this form, what logical operator should be applied across
the ${isc.DocUtils.linkForRef('object:Criterion','criteria')} produced by the form items? Only applicable to
forms that have a dataSource
.
OperatorId
to be used when DynamicForm.getValuesAsCriteria()
is called.
optionDataSource
, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
optionDataSource
, and this property is
not null, this will be passed to the datasource as RPCRequest
properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
autoFetchDisplayMap
is set, this attribute
provides a way to customize the dataSource request issued to fetch the display map from
the option dataSource.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
'autoFetchDisplayMap'
is set, this attribute
provides a way to customize the operationId
passed to
dataSource.fetchData()
when retrieving the display map from the option dataSource.
optionDataSource
, where
autoFetchDisplayMap
is true, this property
will govern the textMatchStyle
attribute of the DSRequest
parameter passed
to DataSource.fetchData()
when retrieving the remote data set to be used as a basis for
thiis field's valueMap.
showOtherDays
is false.
Other...
item.
Other...
item.
'overCanvas'
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accomodate members.
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accomodate the resized sections.
Overflow
settings can be used on TileLayouts, for example, an overflow:auto
TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to
accomodate members.
'this.padding'
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
'this.padding'
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
"summary"
.
([name][pathDelim]?)*
'snapTo'
.
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
].
showTabPicker
is true, this property governs the size
of tab-picker button.
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
].
showPickerIcon
is true for this item, this
property governs the size of the picker icon.
showPickerIcon
is true for this item,
this property governs the size of the picker icon.
showPickerIcon
is true for this item, this
property governs the src of the picker icon image to be displayed.
showPickerIcon
is true for this item,
this property governs the src of the picker icon image to be displayed.
showPickerIcon
is true for this item, this
property governs the size of the picker icon.
showPickerIcon
is true for this item,
this property governs the size of the picker icon.
showTabPicker
is true for this TabSet, if set this
property will determine the title of the picker menu item for this tab.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
prettyPrint
feature to enable indented, highly readable JSON
messages.
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.
preventHTTPCaching
on a per-operationType
basis.
'previous'
toolbar button
'showHover'
is true.
com.smartgwt.client.rpc.RPCManager#promptStyle
is set to "cursor"
for this request only.
ComponentSchema
for fields that contain other components, this flag
suppresses auto-construction for subcomponents that appear under this field.
'serverType'
"sql", determines whether we
qualify column names with table names in any SQL we generate.
drawAheadRatio
, to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid).
ExpansionMode
is "related".
RecordList
.
ListGridFieldType
), this attribute
specifies a custom base style to apply to cells in the summary field
"summary"
.
recordXPath
.
xmlRecordXPath
or jsonRecordXPath
is used based on
the dataFormat
setting.
DataSource
containing data related to the passed record.
canRemoveRecords
is enabled, default icon to
show in the auto-generated field that allows removing records.
'id field value'
as existing nodes, the existing nodess are removed
when the new nodes are added.
DataSourceField
,
enabling both client and server side validation.
requiresRole
, but controls access to
the DataSource as a whole.
showResizeBar
is set to true
so that a resizeBar is created, resizeBarTarget:"next"
can be
set to indicate that the resizeBar should resize the next member of the layout rather than this one.
ResultSet
.
roundValues
is false, the slider value will be rounded to
this number of decimal places.
roundValues
is false, the slider value will be rounded to
this number of decimal places.
dataSource
, this property can
be set to true
to avoid the grid from attempting to save / retrieve data from the server.
true
, when the user hits the Enter key while focussed in a text-item in this form, we automatically
submit the form to the server using the DynamicForm.submit()
method.
FilterBuilder.addSearchHandler(com.smartgwt.client.widgets.form.events.SearchHandler)
method.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
showTabScroller
is true, this property governs the
size of scroller buttons.
'tab scroller buttons'
, and
'symmetricScroller'
is true, this property governs
the base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with
'tabBarPosition'
set to "top" or "bottom"].
'tab scroller buttons'
, and
'symmetricScroller'
is false, this property governs
the base URL for the tab bar back and forward scroller button images.
'tab scroller buttons'
, and
'symmetricScroller'
is true, this property governs
the base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with 'tabBarPosition'
set to "left" or "right"].
'workday hours'
to be sized to
fill the available space in the day view and week view, and automatically scrolls these views to the start of the
workday when the calendar is first displayed and whenever the user switches to a new day or week.
SectionItem
s], this attribute
controls whether multiple sections can be expanded at once.
String
object.TreeGrid.setSelectedPaths(java.lang.String)
to reset this grid's selection the
current state (assuming the same data is present in the grid).selectionType
is "single"
, or if you
only care about the first selected record in a multiple-record selection.
selectionType
is "single"
, or if you only care about the first selected record in a multiple-record selection.
String
object.ListGrid.setSelectedState(java.lang.String)
to reset this grid's selection the
current state (assuming the same data is present in the grid).useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#getSelectionRange
implementation on this items
freeform text entry field.
TextItem
, TextAreaItem
) is
given focus programmatically (see DynamicForm.focusInItem(int)
), all text within
the item will be selected.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
this.useTextField
is false), this
property allows customization of the order of the day, month and year selector fields.
dropExtraFields
, for data sent to the
server.
metaDataPrefix
."getParams"
or "postParams"
only.
members
.
Other...
item in the drop down list.
Other...
value.
'serverType:"sql"'
with a field of type
"sequence", the name of the SQL sequence that should be used when inserting new records into this table.
callback
as data
.
DynamicForm.getValues()
?
'separator rows'
in between.
separatorRows
in between.
separatorRows
in between.
Window.addCloseClickHandler(com.smartgwt.client.widgets.events.CloseClickHandler)
.
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
component.fields
.
DynamicForm
will set both 'showComplexFields'
and
showComplexFieldsRecursively
on any nested component used for showing/editing a complex field.
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder.
customIconProperty
), show open state images when the
folder is opened.
customIconProperty
), show open state images when the
folder is opened.
'dateChooser'
is displayed.
detail:true
when a DataBoundComponent is
given a DataSource but no component.fields
.
prevYearIcon
and
nextYearIcon
.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
"target"
, should we show a shadow behind the canvas
during the drag.
icon
), this
property allows the developer to specify on a per-node basis whether a drop state icon should be displayed when the
user drop-hovers over this folder.node.showDropIcon
to true to show the drop state icon, or false
to suppress this.showCustomIconDrop
for this node.
EdgedCanvas
should be used to show image-based edges around this
component.
emptyMessage
when there is no data to
display?
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'canFilter:false'
fields
specified on the dataSource will not be shown unless explicitly included in this component's 'fields array'
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
'showFocused'
is true for this widget, should the
"over"
state be used to indicate the widget as focused.
showFocused
property.
showPickerIcon
is true for this item,
should the picker icon show a focused image when the form item has focus?
showFocused
, showFocusedIcons
), this property governs whether
the focused state should be shown when the item as a whole recieves focus or just if the icon recieves focus.
showConnectors
is true, this property determines
whether we should show showing vertical continuation lines for each level of indenting within the tree.
showGridSummary
is true, should this field show
a summary value.
'grouping'
, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields.
showGroupSummary
is true, should this field
show a summary value in a summary row when the grid is grouped? If unset, this field will show a summary value in the
summary row if an explicit summaryFunction
is
specified or if a com.smartgwt.client.data.SimpleType#getDefaultSummaryFunction
is defined for the specified
field type.
header
for this Window.
headerSrc
and hiliteHeaderSrc
, otherwise the background
will be styled according to headerStyle
/ hiliteHeaderStyle
.
'showHeaderContextMenu'
is
true, the headerMenuButton
will be displayed when
the user rolls over the header buttons in this grid.
hidden:true
when a DataBoundComponent is given a
DataSource but no component.fields
.
this.canHover
is true, should we show the global hover canvas by default when the user hovers over this
canvas?
icons
for
this item.
fields
from another DataSource
(via inheritsFrom
), indicates that only the fields listed in
this DataSource should be shown.
showHeaders
is also set, each column's
header will show a count of the number of nodes in that column
icon
), this
property allows the developer to specify on a per-node basis whether an open state icon should be displayed when the
folder is open.
open
folders than closed folders.
open
folders than closed folders.
valueMap
, by default we show the valueMap
options in the pickList for the item.
valueMap
by default we show the
valueMap options in the pickList for the item.
valueMap
, by default we show the valueMap
options in the pickList for the item.
Over
state?
overCanvas
on user rollover.
showOver
property.
'edges'
.
'edges'
,
setting this attribute to true
will set the paneContainer to show 'customEdges'
for the three sides opposing the tabBarPosition.
icon
for this form item.
Alt+Arrow Down
key combination?
showPrompt
if it's unset.
showGrip
is true, this property determines whether to show
the 'Over' state on the grip image when the user rolls over on this widget.
showGrip
is true, this property determines whether to show
the 'Over' state on the grip image when the user rolls over on this widget.
Tree.getOpenList(com.smartgwt.client.widgets.tree.TreeNode)
includes the root node.
labelAsTitle
.
StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.headerSpans
are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid
displays a Tree.
valueIcons
is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
.
'frozen'
fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?true
any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).
record[this.singleCellValueProperty]
is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty]
.
Page.getSkinDir()
.
Page.getSkinDir()
.
Page.getSkinDir()
.
'snapTo'
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element.
'snapTo'
is defined for this widget, this property can be used
to specify an offset in px or percentage for the left coordinate of this widget.
'snapTo'
is defined for this widget, this property can be used
to specify an offset in px or percentage for the top coordinate of this widget.
'masterElement'
(if specified), or its 'parentElement'
.
sortBy
.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to sort a field in ascending order.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to sort a field in descending order.
sortBy
.
String
object.ListGrid.setSortState(java.lang.String)
to reset this
grid's sort to the current state (assuming the same fields are present in the grid).'WSDL web service'
,
setting this flag means the DataSource doesn't actually attempt to contact the server but generates a sample response
instead, based on the XML Schema of the response message embedded in the WSDL.
memberOverlap
, controls
the z-stacking order of members.
CalendarEvent
.
CalendarEvent
.
baseStyle
as the component changes state and/or is selected.
canAddSummaryFields
.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to specify fetch
criteria to apply when retrieving summary data to show in the summary row.
showGridSummary
is true, by default summary
values are calculated on the client based on the current data-set for the grid (see ListGrid.getGridSummary(com.smartgwt.client.widgets.grid.ListGridField)
and com.smartgwt.client.widgets.grid.ListGrid#getGridSummaryFunction
).
ListGrid.setShowGridSummary(Boolean)
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch
request used when retrieving summary data to show in the summary row.
'summary row autoChild'
.
baseStyle
for the summaryRow
title
.
valueIcons
is set, this property may be set to
prevent the value icons from showing up next to the form items value
'show edges'
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides).
'tab picker button'
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible 'tabBarPosition'
based on the pickerButtonSrc
property for this tabSet.
'tab scroller buttons'
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible 'tabBarPosition'
based on the scrollerSrc
property for this tabSet.
'Smart GWT SQL engine'
for persistence, what
database table name to use.
useTextField
is true
this
property governs the alignment of text within the text field.
com.smartgwt.client..SimpleTile
, CSS style for each value shown within a tile.
Canvas.getPrompt()
"Submit"
by default.
Tree
.
titleField
for databound
compounds."title"
,
"name"
, or "id"
.
TreeNode
that holds the title of the node as it
should be shown to the user.
titleStyle
, can set to provide a separate style
for the title text.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to toggle whether a field is frozen or unfrozen.
Canvas.getPrompt()
position
property).
position
property).
CalendarEvent
.
RPCManager.sendQueue()
containing the RPCRequest
associated with this response.
treeField: true
will display the Tree
.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to unfreeze a currently frozen field.
'headerContextMenu'
for
this grid, and 'this.isGrouped'
is true, this attribute
will be shown as the title for the menu item to ungroup the grid.
Page.checkBrowserAndRedirect()
if they
are accessing this page in an unsupported browser and com.smartgwt.client.util.Page#unsupportedBrowserAction
is
set to "confirm"
.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set? This attribute will be passed to DataSource#getUpdatedData
as the useDataFromRequest
parameter.
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
useFlatFields
, but applies to all DataBound
components that bind to this DataSource.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML
message to send to the web service, properties in
'request.data'
will be used as the values for XML elements of the same name, at
any level of nesting.
useFlatFields
on an operationBinding is equivalent to setting useFlatFields
on all DataSource requests with the same operationType
as this operationBinding
.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML message to send to the web service, properties in
data
will be used as the values for XML elements of the same name, at
any level of nesting.
useFlatFields
flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
'useFlatFields'
XML serialization behavior to be
used for all soap headers in the request.
useHttpProxy
, but serves as a default for this
DataSource that may be overriden by individual operationBindings.
com.smartgwt.client.rpc.RPCManager#sendProxied
servlet to send requests described by this
operationBinding.
displayFormat
.
fields
from another DataSource
(via inheritsFrom
), indicates that the parent's field order
should be used instead of the order of the fields as declared in this DataSource.
validators
for this field will
be run whenever the value of the field is changed.
com.smartgwt.client..ValidatorTypes#hasRelatedRecord
validator to every field on this dataSource that has a 'foreignKey'
defined.
type
to be "header", the
value of this attribute specifies the header text.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an optionDataSource
, this property denotes
the the field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
optionDataSource
field used to
retrieve the stored values that are to be mapped to the display values (specified by displayField
).
valueField
for this
item.
valueField
for this
item.
valueField
for this item.
valueField
for this
item.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
is specified, use this property to
specify a height for the value icon written out.
valueIconLeftPadding
valueIconRightPadding
valueIcons
is specified, this property may be
used to specify both the width and height of the icon written out.
valueIcons
is specified, use this property to
specify a width for the value icon written out.
{ item[idField] -> item[displayField] }
, for all items in the list.
{ item[idField] -> item[displayField] }
, for all items in the list.
ValuesManager
for managing values displayed in this component.
Splitbar
is created by a layout to be the resizeBar for
some member of the layout, the vertical
property will be set to true
if the layout is
horizontal, meaning this resizeBar will be taller than it is wide, and will allow horizontal resizing of the member.
Splitbar
is created by a layout to be the resizeBar for
some member of the layout, the vertical
property will be set to true
if the layout is
horizontal, meaning this resizeBar will be taller than it is wide, and will allow horizontal resizing of the member.
String
object.ListGrid.setViewState(java.lang.String)
to reset this grid's vew state to the current state (assuming
the same data / fields are present in the grid).vertical
is true, and src
is unset.
vertical
is true and src
is unset.
vertical
is true and src
is unset.
Canvas.addMouseWheelHandler(com.smartgwt.client.widgets.events.MouseWheelHandler)
events only.
showWorkday
is set, style used for cells that
are within the workday, as defined by workdayStart
and workdayEnd
.
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to com.smartgwt.client..Time#parseInput
.
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to com.smartgwt.client..Time#parseInput
.
DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
should serialize this value as an XML attribute.
recordXPath
mapping to the data node of XML returned by the server.
Applies if this.dataFormat is set
to "xml"
.HandlerManager
.HandlerManager.addHandler(com.google.gwt.event.shared.GwtEvent.Type, EventHandler)
.DynamicForm.setErrors(java.util.Map, boolean)
or DynamicForm.setFieldErrors(java.lang.String, java.lang.String, boolean)
.
DynamicForm.setErrors(java.util.Map, boolean)
or DynamicForm.setFieldErrors(java.lang.String, java.lang.String, boolean)
.
storeWithHash
)Window
Header, or SectionStackSection
.com.smartgwt.client.widgets.Hover#show
canDropComponents
set to true.
FormItem.hide()
Button
class.StretchImg
background.Img
class.this.data.invalidateCache()
.
'checkboxField'
used when SelectionAppearance
is "checkbox".
'expansionField'
used when canExpandRecords
is true.
saveOperationType
is currently
"add".
saveOperationType
is
currently "add".
JSONEncoder
should do when it encounters a circular reference in an object structure.canFocus
:
true).
'alignable'
'text'
with optional 'icon'
and 'autoFit'
.layoutChildren()
is where a Canvas should implement a sizing policy for it's Canvas children.
DataBoundComponent
that displays a list of objects in a grid, where
each row represents one object and each cell in the row represents one property.ListGrid
.'contentsType'
set to "page"
BaseWidget.destroy()
this canvas on a timeout.
com.smartgwt.client..MultiFileItem
to allow the user to enter
several files for upload.MultiSortDialog
.SortSpecifier
s.ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
com.smartgwt.client.data.Criterion
that uses this operator.percentBox
.dataProtocol
.
DataBoundComponent
.com.smartgwt.client.widgets.grid.ListGridField#showIf
for each field, dynamically showing and
hiding the appropriate set of fields
expression
which takes three parameters:
item - the DynamicForm item on which the error occurred (may be null) validator - a pointer to the
validator object value - the value of the field in question
When validation is perfomed, the expression will be evaluated - if it returns true
, the field will be
treated as a required field, so validation will fail if the field has no value.setValues()
or rememberValues()
was called.
DynamicForm.resetValues()
If you define a click
handler on this item, you can return false to cancel the reset.DynamicForm.reset()
.
DynamicForm.reset()
.
Window.minimize()
or Window.maximize()
.
RecordList
that automatically fetches
DataSource records when items are requested from the List.startRow
to false
to create a rowSpacer
that simply takes up every remaining column in the current row rather than starting a new row.DataSource
this form is
bound to.
DataSource
this form is
bound to.
DataSource
this form is
bound to.
<xsd:schema>
element in a WSDL or XML schema file loaded by
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback)
or XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback)
.DynamicForm
.Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
passed in explicitly, or by index, and deselect everything else.
Record
passed in explicitly, or by index, and deselect everything else.
useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#selectValue
implementation on this items freeform text
entry field.
baseStyle
for all cells
for this particular record.
edgeStyleName
will be treated as a
base style name and appended with following suffixes to support separate styling per cell:
'add event'
toolbar button
DataSource
s that have
a 'primaryKey'
, and all primary key values are present in
the request.
alternateRecordStyles
is true for this grid.
alternateWeekStyles
.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
canRemoveRecords
is enabled, should records
be animated out of view when they are removed by the user?
'animating record removal'
, this property
designates the speed of the animation in pixels per second.
'(see
animateRemoveRecord)'
, if animateRemoveSpeed
is not set, this property designates the duration of the animation in ms.
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?
'HTML fragments'
, ViewLoader
,
XML or JSON flat data files, videos, etc.
'HTML fragments'
, ViewLoader
,
XML or JSON flat data files, videos, etc.
Page.getAppImgDir()
.
autoPosition
is false, this property controls
whether to automatically center the colorPicker every time it is reshown with the show() method.
tableName
.
'field.name'
for
any field that does not have a 'field.title'
and is not
marked 'hidden'
:true, by calling the method com.smartgwt.client.data.DataSource#getAutoTitle
.
DataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
depending on
DataBoundComponent.getAutoFetchAsFilter()
.
dataSource
, should options be fetched from the server when
the item is first written out, or should this fetch be delayed until the user opens the pickList.
dataSource
, should options be fetched from the server when
the item is first drawn, or should this fetch be delayed until the user opens the pickList.
optionDataSource
is
specified, a valueMap will be automatically created by making a DataSource.fetchData()
call against the specified dataSource and extracting a valueMap from the returned records based on the displayField and
valueField.
optionDataSource
.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial Calendar.fetchData()
call.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial DynamicForm.fetchData()
call.
autoFetchData
is true
, this
attribute allows the developer to specify a textMatchStyle for the initial ColumnTree.fetchData()
call.
autoFetchData
, or filtered by the user via the 'filterEditor'
, this attribute can be used to set the textMatchStyle
on the dsRequest passed to
fetchData()
.
autoFetchData
is true
, this attribute
allows the developer to specify a textMatchStyle for the initial TileGrid.fetchData()
call.
autoFetchTextMatchStyle:"exact"
.
autoFitData
is set to "vertical"
or
"both"
this property specifies the number of additional records for which the grid will expeand.
autoFitData
is set to "horizontal"
or
"both"
this property provides the maximum number of columns for which the ListGrid will expand.
autoFitData
is set to "vertical"
or
"both"
this property provides an upper limit on how far the ListGrid will expand vertically to accomodate
its content.
autoFitData
is set to "vertical"
or
"both"
this property provides the maximum number of records for which the ListGrid will expand.
autoFitData
is set to "horizontal"
or
"both"
this property provides an upper limit on how far the ListGrid will expand horizontally to accomodate
its content.
dynamicForm.focusInItem(itemName)
Tree.setRoot(com.smartgwt.client.widgets.tree.TreeNode)
is called.
saveByCell
is true).
LayoutPolicy
is "flow", should we automatically start a new line when there's not
enough room to fit the next tile on the same line?
baseStyle
will be applied to the button.
baseStyle
To override the baseStyle at the row level, use
'record[listGrid.recordBaseStyleProperty]'
instead.
'serverType'
:
booleanTrueImage
and the booleanFalseImage
Note: If booleanTrueImage
is unset, the checkedImage
will be used to indicate a true value
in a boolean field.
booleanTrueImage
and booleanFalseImage
.
RPCTransport
transport, this attribute
specifies the name
of the URL parameter which is used to specify the callback function that
the server is expected to call by writing
out JavaScript code.
false
, other records cannot be dropped on (i.e., inserted via drag and drop) immediately before
this record.
treeNode
s) may be dropped over this node.
com.smartgwt.client..FormulaBuilder
.
com.smartgwt.client..SummaryBuilder
.
this.confirmCancelEditing
is true this property is used as the message
to display in the confirmation dismissal prompt.
DynamicForm.cancel()
DynamicForm.cancel()
'target'
, hiding it and shifting the Splitbar and other members of the
layout across to fill the newly available space.
'target'
, hiding it and shifting the Splitbar and other members of the
layout across to fill the newly available space.
false
, this record cannot be dragged.
canDrag
set to true to allow dragging of the split bar.
canDrag
set to true to allow dragging of the split bar.
CalendarEvent
that determines editability.
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.
'selectionAppearance'
set to "checkbox"
com.smartgwt.client..ValueMap
field to be edited without going into edit mode.
align
.
FormItem.setValue(int)
.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for an unselected row.
selectionAppearance
is set to
"checkbox"
this property may be set to govern the height of the checkbox image displayed to indicate
whether a row is selected.
selectionAppearance
is set to
"checkbox"
this property may be set to govern the width of the checkbox image displayed to indicate whether
a row is selected.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for a selected row.
ExpansionMode
that show another grid or tree, what the child's expansionMode
should be.
childrenProperty
directly on
the childrenField object.
'multiple:"true"'
, controls the name of
the XML tag used for each subelement during DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
'headerContextMenu'
for
this grid, and a 'filter-editor'
is visible, this
attribute will be shown as the menu item title to clear any existing filter.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
folderIcon
for
closed folders.
folderIcon
for
closed folders.
canCloseTabs
is true.
canCloseTabs
is true.
canCloseTabs
is true.
Tab
key.
DataBoundComponent
, the ID
of the submitting component.
this.confirmDiscardEdits
is true, this property can be used to customize the error message string
displayed to the user in a dialog with options to cancel the action, or save or discard pending edits in response to
sort/filter actions that would otherwise drop unsaved edit values.
showConnectors
is true.
'Relogin'
, this property marks this request an attempt to login,
therefore a response containing the loginRequiredMarker
is a normal condition and should result in the
status code RPCResponse.STATUS_LOGIN_INCORRECT
rather than a call to com.smartgwt.client.rpc.RPCManager#loginRequired
.
contentsURL
is assumed to be an HTML fragment rather than a
complete page.
src
specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment.
httpMethod
is set to "POST".
btnSize
.
operator
, the name of the DataSource
field for the ${isc.DocUtils.linkForRef('object:Criterion')} this FormItem generates.
ResultSet
cache should be dropped when the criteria
changes.
Criteria
changes.
'default node.showDropIcon'
property.
'default node.showOpenIcon'
property.
'default node.showOpenIcon'
property.
'default
node.icon'
property.
Tree
object consisting of nested TreeNode
s to display in this ColumnTree.
Tree
object containing of nested TreeNode
s to display as rows in this TreeGrid.
DataSource.fetchData()
is called).
ResultSet
object created for this grid when data is fetched
DataSource
is this resultSet associated with?
DSRequest
.
dateFormatter
is set at init time, it will be used instead of displayFormat
to govern how dates are displayed in
this item.
inputFormat
applied to editors for fields of type "date"
3 character string containing the "M", "D" and "Y" characters to indicate the format of strings being parsed into Date instances via Date.parseInput().
'date picker'
toolbar button
'Smart GWT SQL engine'
for persistence, which
database configuration to use.
'field.groupingMode'
is unset.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to
the height of the header when minimized.
titleProperty
value or
a nameProperty
value.
CalendarEvent
The name of this
field within the CalendarEvent can be changed via descriptionField
CalendarEvent
.
BaseWidget.destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab(int)
}.
DataBoundComponent
.
recordDetailDSProperty
.
'canExpandRecords'
is true
and ExpansionMode
is detailField
.
confirmDiscardEdits
is true this is the
title for the save button appearing in the lost edits confirmation dialog.
'modelType:"parent"'
, should nodes in the
data array for the tree be dropped if they have an explicitly specified value for the parentIdField
which doesn't match any other nodes in the tree.
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.optionDataSource
field used to
retrieve the display values that are to be mapped from the internal values specified by valueField
.
useTextField
is true
this
property can be used to customize the format in which dates are displayed.DateDisplayFormat
or a function which will return a formatted date string.
DateDisplayFormat
or a function which will return a formatted date time string.
"target"
, this value specifies the opacity to render the target while it
is being dragged.
drawAllMaxCells
cells to be rendered, the full dataset will
instead be drawn even if 'showAllRecords'
is false
and the viewport size and drawAheadRatio
setting
would normally have caused incremental rendering to be used.
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user
drop-hovers over some folder.
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user drop-hovers
over some folder.
canDropComponents
is set to true
.
addDropValues
is true and both
the source and target widgets are databound, either to the same DataSource or
to different DataSources that are related via a foreign key, this object
provides the "drop values" that SmartGWT will apply to the dropped object
before updating it.
preventDuplicates
is enabled.
ListGridEditEvent
for options.
this.editFailedCSSText
this.editFailedBaseStyle
instead.
iconHeight
.iconHeight
instead.
iconWidth
.iconWidth
instead.
imageURLPrefix
to the editor in question.
imageURLSuffix
to the editor in question.
FormItemValueFormatter
to map this item's current data value to a
display value.
FormItemValueParser
to map a user-entered display value to a data
value for storage.
this.editPendingBaseStyle
instead.
emptyMessage
if
displayed.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
CalendarEvent
The name of
this field within the CalendarEvent can be changed via endDateField
CalendarEvent
.
fixedRecordHeights
is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers.
enterKeyEditAction
as
specified at the listGrid level while focus is in this field.
EnumTranslateStrategy
is set to "bean".
EnumTranslateStrategy
is set to "bean".
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.showInlineErrors
and showErrorText
are both true and errorOrientation
is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accomodate the error message and icon.
showInlineErrors
is true, where
should the error icon and text appear relative to the form item itself.
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.escapeKeyEditAction
as
specified at the listGrid level while focus is in this field.
serverOutputAsString
except
the resulting String
is automatically evaluated as JavaScript.
evalScriptBlocks
is true, HTMLFlow will pre-process the loaded HTML in order to mimic how the HTML would
execute if it were loaded as an independent page or loaded via an IFRAME.
RPCRequest.setEvalResult(Boolean)
: true, then the property values of this object will
be available in the evaluation scope of the result under the variable names specified by the property names.
eventDialog
.
eventEditor
.
eventAutoArrange
is true, setting
eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified
by eventOverlapPercent
.
timelineView
eventWindowStyle
for an individual CalendarEvent
.
showHeader
is set to false
in which
case they default to the expanded state.
LayoutPolicy
:"fit", should margins be expanded so that tiles fill the available
space in the TileLayout on the breadth axis? This can also affect tileWidth
or tileHeight
.
ExpansionMode
that show another grid or tree, is that component editable?
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for collapsed rows.
canExpandRecords
is set to true
,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for expanded rows.
ExpansionMode
for records in this grid.
exportFilename
and
exportAs
respectively.
exportFilename
and
exportAs
respectively.
showFilterEditor
is true), and we're re-filtering on every keypress (filterOnKeypress
is true), this property is the delay in
milliseconds between the user changing the filter and the filter request being kicked off.
displayField
is specified for this item,
should the item perform a fetch on the optionDataSource
to retrieve the display value for the item when FormItem.setValue(int)
is called with a value for which we do not already have a
mapped display value?
String
object passed in.ListGrid.getFieldState()
.
String
object passed in.TileGrid.getFieldState()
.
'headerContextMenu'
for
this grid, and 'this.canPickFields'
is true, this
attribute will be shown as the title for the menu item which contains a submenu with items allowing the user to show
and hide fields in the grid.
showFilterEditor
is true, this method will update the criteria shown in the filterEditor
without performing a filter.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
optionDataSource
, displayField
and fetchMissingValues
), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch
the entire set of options from the server, and use these values to map the item value to the appropriate display
value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
showHeaders
is set
(the remaining columns have their titles derived from the item selected in the column to the left).
DynamicForm.submitForm()
a form
is unable to submit to the server.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze a currently unfrozen field.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
showGridSummary
is true, this attribute will be
set to true on the record object representing the grid summary row.
gripImgSuffix
to simplify providing custom
grip media for this widget.
showGrip
is true
ComponentSchema
, indicates what group to place the property in when editing
in Visual Builder.
'headerContextMenu'
for
this grid and 'this.canGroupBy'
is true, this string
will be shown as the title for the menu item to toggle the group by setting for a field.
'grouping
modes'
, the current grouping mode.
showGroupSummary
is true, this attribute will
be set to true on each record object representing a group-level summary row.
customStyle
for the group-level summary row
displayed when showGroupSummary
is true.
baseStyle
to apply to the buttons in the header, and the sorter,
for this ListGrid.
headerBaseStyle
.headerTitleStyle
as well.
showHeaderMenuButton
is true, this property
governs the height of the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the auto-generated headerMenuButton
'headerSpan'
with no height
specified.
'headerSpan'
dynamically.
showHeaderBackground
is true
, this
property provides the URL of the background image for the header.
titleStyle
to apply to the buttons in the header, and
the sorter, for this ListGrid.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass thereof.
type
: "separator"
, this attribute
specifies the height of the separator.
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.'accessKey'
, underline it in
the title of the button by default
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.showHeaderBackground
is true, this governs the URL
of the image to use in the header's highlighted state when the window is Window.flash()
this.showHover
is true, this property can be used to customize the alignment of content in the hover
canvas.
this.canHover
is true, how long should the mouse be kept over this widget before the hover event is
fired
this.form.itemHoverDelay
will be used instead.
this.showHover
is true, this property can be used to customize the height of the hover canvas shown.
this.showHover
is true, should this widget's hover canvas be moved with the mouse while visible?
this.showHover
is true, should the hover canvas be shown with opacity other than 100?
this.showHover
is true, this property can be used to specify the css style to apply to the hover canvas.
this.showHover
is true, this property can be used to customize the vertical alignment of content in the
hover canvas.
'this.showHover'
is true, this property can be used to
customize the width of the hover canvas shown.
this.showHover
is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps.
vertical
is false, and src
is unset.
vertical
is false and src
is unset.
vertical
is false and src
is unset.
htmlElement
is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement
in the DOM.
FieldType
:"image" as the field to use when rendering a record as
an image, for example, in a TileGrid
.
icon
is specified, this property can be used to
specify the height of the icon to be displayed in the ListGrid header button.
"left"
and "right"
.
"left"
or "right"
"left"
and "right"
.
"left"
and "right"
.
"left"
and "right"
.
"left"
and "right"
.
icons
to be displayed in the editors displayed for this field
icon
is specified, this property can be used to
specify the size of the icon to be displayed in the ListGrid header button.
iconVAlign
.
icon
is specified, this property can be used to
specify the width of the icon to be displayed in the ListGrid header button.
modelType
"parent", this property
specifies the unique ID of this node.
TreeNode
that holds an id for the node which is
unique across the entire Tree.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
valueIcons
when determining the URL for the image.
ListGridFieldType
] set to "image"
and the URL for
the image displayed is not absolute, the path of the URL will be relative to this stringvalueIcons
when determining the URL for the image.
"image"
and the URL for the image displayed is not absolute, the path of the
URL will be relative to this stringvalueIcons
when
determining the URL for the image.
valueIcons
) or this is has ListGridFieldType
set to "image"
, this the value of this property will be
appended to the end of the URL for the icon displayed.".gif"
to the filename of the image.imageURLSuffix
.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
ComponentSchema
, a field 'inherited'
from another schema can be redeclared with this
property set in order to indicate that the property should not be used.
'summary row'
for this grid.
'grid summary'
.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
useTextField
is true
this
property can be used to specify the input format for date strings.
useTextField
is true
this
property can be used to specify the input format for date strings.
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.
showGridSummary
, showGroupSummary
or ListGridFieldType
), and the summary function returns "null"
(implying it was
unable to calculate a valid summary value).
true
to explicitly mark this node as a folder.
showGridSummary
is true.
showGroupSummary
is true.
canRemoveRecords
is true, this
field will be rendered as the remove-field for this grid.
true
, defines a horizontal separator in the
listGrid object.
true
, this menu item shows a horizontal separator instead of the title
text.
record[this.isSeparatorProperty]
is set for some record, the record will be displayed as a simple
separator row.
DynamicForm.setFields(com.smartgwt.client.widgets.form.fields.FormItem[])
.
data
Synonym for Menu.setData(com.smartgwt.client.widgets.menu.MenuItem...)
.
javaClass
specifies the fully qualified Java className to be created and passed to the setter for the Java
Bean Property with the same name as this field.
javaClass
- when auto-populating of Java Beans / POJOs
based on inbound DSRequest data, for a field of type Collection or Map, javaCollectionClass
can be used
to specify a particular concrete class to use.
javaClass
- when auto-populating of Java Beans / POJOs
based on inbound DSRequest data, for a field of Map type, javaKeyClass
can be used to specify a particular
concrete class for the map keys.
recordXPath
mapping to the data node of json returned by the server.
Applies if this.dataFormat is set
to "json"
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see 'form layout overview'
).
CalendarEvent
.
position
property).
position
property).
contentsURL
property has been set.
loadingMessage
.
this.longTextEditorType
(a TextAreaItem by default), rather than a simple
text item.
length
exceeds this
value, the ListGrid shows an edit field of type longTextEditorType
rather than the standard text field when the field enters inline edit mode.
length
exceeds
this.longTextEditorThreshold
show an edit field of this type rather than the standard text field when the
field enters inline edit mode.
layoutMargin
.
useTextField
and useMask
are both true
this value is the
separator between date components.
htmlElement
is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?FieldType
), this sets the maximum file size allowed, in bytes.
MenuButton
generated for it automatically (for example
when included in a MenuBar
, the width that the MenuButton should have.
sendMetaData
is true, this attribute is used to
specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server.
canvas.animationTime
.
'field.name'
.
CalendarEvent
The name of this field
within the CalendarEvent can be changed via nameField
CalendarEvent
.
TreeNode
that holds a name for the node that is
unique among it's immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file
system.
icon.neverDisable
is true, when this form item is disabled, the icon will remain enabled.
ResultSet.setCriteria(com.smartgwt.client.data.Criteria)
are applied to it, and it may disappear from the cache.
'next'
toolbar button
update
or remove
operation, the original values from the record that is being updated
or removed.
update
or remove
operation, the original values from the record that is being updated
or removed.
update
or remove
operation, the original values from the record that is being updated
or removed.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
Tree.isOpen(com.smartgwt.client.widgets.tree.TreeNode)
to
determine if the node is open or not.
String
object passed in.TreeGrid.getOpenState()
.
DataBoundComponent
sends a DSRequest, the dsRequest.operationId
will be automatically picked up from the fetchOperation
, addOperation
, etc properties of the
DataBoundComponent.
operator
has been set for any FormItem
in this form, what logical operator should be applied across
the ${isc.DocUtils.linkForRef('object:Criterion','criteria')} produced by the form items? Only applicable to
forms that have a dataSource
.
OperatorId
to be used when DynamicForm.getValuesAsCriteria()
is called.
optionDataSource
, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
optionDataSource
.
optionDataSource
.
valueField
and
displayField
in the loaded records,
to derive one valueMap entry per record loaded from the optionDataSource.
optionDataSource
, and this property is
not null, this will be passed to the datasource as RPCRequest
properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
autoFetchDisplayMap
is set, this attribute
provides a way to customize the dataSource request issued to fetch the display map from
the option dataSource.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
'autoFetchDisplayMap'
is set, this attribute
provides a way to customize the operationId
passed to
dataSource.fetchData()
when retrieving the display map from the option dataSource.
optionDataSource
, where
autoFetchDisplayMap
is true, this property
will govern the textMatchStyle
attribute of the DSRequest
parameter passed
to DataSource.fetchData()
when retrieving the remote data set to be used as a basis for
thiis field's valueMap.
showOtherDays
is false.
Other...
item.
Other...
item.
'overCanvas'
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accomodate members.
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accomodate the resized sections.
Overflow
settings can be used on TileLayouts, for example, an overflow:auto
TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to
accomodate members.
'this.padding'
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
'this.padding'
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
"summary"
.
'snapTo'
.
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
].
showTabPicker
is true, this property governs the size
of tab-picker button.
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
].
showPickerIcon
is true for this item, this
property governs the size of the picker icon.
showPickerIcon
is true for this item,
this property governs the size of the picker icon.
showPickerIcon
is true for this item, this
property governs the src of the picker icon image to be displayed.
showPickerIcon
is true for this item,
this property governs the src of the picker icon image to be displayed.
showPickerIcon
is true for this item, this
property governs the size of the picker icon.
showPickerIcon
is true for this item,
this property governs the size of the picker icon.
showTabPicker
is true for this TabSet, if set this
property will determine the title of the picker menu item for this tab.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
optionDataSource
, and this property is not null, this will be passed to
the datasource as RPCRequest
properties when performing the filter operation on
the dataSource to obtain the set of options for the list.
showDragPlaceHolder
is true, this
defaults object determines the default appearance of the placeholder displayed when the user drags a widget out
of this layout.styleName
to "layoutPlaceHolder"
com.smartgwt.client..Class#changeDefaults
showDragPlaceHolder
is true, this
properties object can be used to customize the appearance of the placeholder displayed when the user drags a
widget out of this layout.
prettyPrint
feature to enable indented, highly readable JSON
messages.
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.
preventHTTPCaching
on a per-operationType
basis.
'previous'
toolbar button
'showHover'
is true.
com.smartgwt.client.rpc.RPCManager#promptStyle
is set to "cursor"
for this request only.
ComponentSchema
for fields that contain other components, this flag
suppresses auto-construction for subcomponents that appear under this field.
'serverType'
"sql", determines whether we
qualify column names with table names in any SQL we generate.
drawAheadRatio
, to be used when the
user is rapidly changing the grids viewport (for example drag scrolling through the grid).
ExpansionMode
is "related".
recordName
.
ListGrid.setData(ListGridRecord[])
ListGridFieldType
), this attribute
specifies a custom base style to apply to cells in the summary field
"summary"
.
"summary"
.
recordXPath
.
xmlRecordXPath
or jsonRecordXPath
is used based on
the dataFormat
setting.
canRemoveRecords
is enabled, default icon to
show in the auto-generated field that allows removing records.
'id field value'
as existing nodes, the existing nodess are removed
when the new nodes are added.
DSRequest
s made by this DataSource.
DSRequest
created for this operation.
DataSourceField
,
enabling both client and server side validation.
requiresRole
, but controls access to
the DataSource as a whole.
showResizeBar
is set to true
so that a resizeBar is created, resizeBarTarget:"next"
can be
set to indicate that the resizeBar should resize the next member of the layout rather than this one.
root
with an id (idField
), then you can provide the root node's id via this property.
root
with an id (idField
), then you can provide the root node's id via this property.
roundValues
is false, the slider value will be rounded to
this number of decimal places.
roundValues
is false, the slider value will be rounded to
this number of decimal places.
dataSource
, this property can
be set to true
to avoid the grid from attempting to save / retrieve data from the server.
true
, when the user hits the Enter key while focussed in a text-item in this form, we automatically
submit the form to the server using the DynamicForm.submit()
method.
FilterBuilder.addSearchHandler(com.smartgwt.client.widgets.form.events.SearchHandler)
method.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
showTabScroller
is true, this property governs the
size of scroller buttons.
'tab scroller buttons'
, and
'symmetricScroller'
is true, this property governs
the base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with
'tabBarPosition'
set to "top" or "bottom"].
'tab scroller buttons'
, and
'symmetricScroller'
is false, this property governs
the base URL for the tab bar back and forward scroller button images.
'tab scroller buttons'
, and
'symmetricScroller'
is true, this property governs
the base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with 'tabBarPosition'
set to "left" or "right"].
'workday hours'
to be sized to
fill the available space in the day view and week view, and automatically scrolls these views to the start of the
workday when the calendar is first displayed and whenever the user switches to a new day or week.
SectionItem
s], this attribute
controls whether multiple sections can be expanded at once.
String
object passed in.TreeGrid.getSelectedPaths()
.
String
object passed in.ListGrid.getSelectedState()
.
useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#setSelectionRange
implementation on this items
freeform text entry field.
TextItem
, TextAreaItem
) is
given focus programmatically (see DynamicForm.focusInItem(int)
), all text within
the item will be selected.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
'selectOnFocus'
behavior to be
configured on a per-FormItem basis.
this.useTextField
is false), this
property allows customization of the order of the day, month and year selector fields.
dropExtraFields
, for data sent to the
server.
metaDataPrefix
."getParams"
or "postParams"
only.
members
.
Other...
item in the drop down list.
Other...
value.
'serverType:"sql"'
with a field of type
"sequence", the name of the SQL sequence that should be used when inserting new records into this table.
callback
as data
.
DynamicForm.getValues()
?
'separator rows'
in between.
separatorRows
in between.
separatorRows
in between.
Window.addCloseClickHandler(com.smartgwt.client.widgets.events.CloseClickHandler)
.
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
component.fields
.
DynamicForm
will set both 'showComplexFields'
and
showComplexFieldsRecursively
on any nested component used for showing/editing a complex field.
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder.
customIconProperty
), show open state images when the
folder is opened.
customIconProperty
), show open state images when the
folder is opened.
'dateChooser'
is displayed.
detail:true
when a DataBoundComponent is
given a DataSource but no component.fields
.
prevYearIcon
and
nextYearIcon
.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
"target"
, should we show a shadow behind the canvas
during the drag.
icon
), this
property allows the developer to specify on a per-node basis whether a drop state icon should be displayed when the
user drop-hovers over this folder.node.showDropIcon
to true to show the drop state icon, or false
to suppress this.showCustomIconDrop
for this node.
EdgedCanvas
should be used to show image-based edges around this
component.
emptyMessage
when there is no data to
display?
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'showErrorIcons'
, 'showErrorText'
, and 'showErrorStyle'
control how validation errors are
displayed next to form items when showInlineErrors
is true.
'canFilter:false'
fields
specified on the dataSource will not be shown unless explicitly included in this component's 'fields array'
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
'showFocused'
is true for this widget, should the
"over"
state be used to indicate the widget as focused.
showFocused
property.
showPickerIcon
is true for this item,
should the picker icon show a focused image when the form item has focus?
showFocused
, showFocusedIcons
), this property governs whether
the focused state should be shown when the item as a whole recieves focus or just if the icon recieves focus.
showConnectors
is true, this property determines
whether we should show showing vertical continuation lines for each level of indenting within the tree.
showGridSummary
is true, should this field show
a summary value.
'grouping'
, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields.
showGroupSummary
is true, should this field
show a summary value in a summary row when the grid is grouped? If unset, this field will show a summary value in the
summary row if an explicit summaryFunction
is
specified or if a com.smartgwt.client.data.SimpleType#getDefaultSummaryFunction
is defined for the specified
field type.
header
for this Window.
headerSrc
and hiliteHeaderSrc
, otherwise the background
will be styled according to headerStyle
/ hiliteHeaderStyle
.
'showHeaderContextMenu'
is
true, the headerMenuButton
will be displayed when
the user rolls over the header buttons in this grid.
hidden:true
when a DataBoundComponent is given a
DataSource but no component.fields
.
this.canHover
is true, should we show the global hover canvas by default when the user hovers over this
canvas?
icons
for
this item.
fields
from another DataSource
(via inheritsFrom
), indicates that only the fields listed in
this DataSource should be shown.
showMaximizeButton
to show / hide the maximizeButton
showHeaders
is also set, each column's
header will show a count of the number of nodes in that column
icon
), this
property allows the developer to specify on a per-node basis whether an open state icon should be displayed when the
folder is open.
open
folders than closed folders.
open
folders than closed folders.
valueMap
, by default we show the valueMap
options in the pickList for the item.
valueMap
by default we show the
valueMap options in the pickList for the item.
valueMap
, by default we show the valueMap
options in the pickList for the item.
Over
state?
overCanvas
on user rollover.
showOver
property.
'edges'
.
'edges'
,
setting this attribute to true
will set the paneContainer to show 'customEdges'
for the three sides opposing the tabBarPosition.
icon
for this form item.
Alt+Arrow Down
key combination?
showPrompt
if it's unset.
showGrip
is true, this property determines whether to show
the 'Over' state on the grip image when the user rolls over on this widget.
showGrip
is true, this property determines whether to show
the 'Over' state on the grip image when the user rolls over on this widget.
Tree.getOpenList(com.smartgwt.client.widgets.tree.TreeNode)
includes the root node.
showShadow
.
labelAsTitle
.
StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.StatefulCanvas.getTitle()
will be displayed for this
component.headerSpans
are in use, whether to show a
hierarchical column picker that includes both headerSpans and normal headers, with normal headers indented under
headerSpans similarly to how a TreeGrid
displays a Tree.
valueIcons
is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
.
'frozen'
fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?true
any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).
record[this.singleCellValueProperty]
is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty]
.
Page.getSkinDir()
.
Page.getSkinDir()
.
Page.getSkinDir()
.
'snapTo'
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element.
'snapTo'
is defined for this widget, this property can be used
to specify an offset in px or percentage for the left coordinate of this widget.
'snapTo'
is defined for this widget, this property can be used
to specify an offset in px or percentage for the top coordinate of this widget.
'masterElement'
(if specified), or its 'parentElement'
.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to sort a field in ascending order.
'headerContextMenu'
for
this grid, this attribute will be shown as the menu item title to sort a field in descending order.
String
object passed in.ListGrid.getSortState()
.
'WSDL web service'
,
setting this flag means the DataSource doesn't actually attempt to contact the server but generates a sample response
instead, based on the XML Schema of the response message embedded in the WSDL.
memberOverlap
, controls
the z-stacking order of members.
CalendarEvent
.
CalendarEvent
.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to specify fetch
criteria to apply when retrieving summary data to show in the summary row.
showGridSummary
is true, by default summary
values are calculated on the client based on the current data-set for the grid (see ListGrid.getGridSummary(com.smartgwt.client.widgets.grid.ListGridField)
and com.smartgwt.client.widgets.grid.ListGrid#getGridSummaryFunction
).
ListGrid.setShowGridSummary(Boolean)
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch
request used when retrieving summary data to show in the summary row.
'summary row autoChild'
.
baseStyle
for the summaryRow
title
.
valueIcons
is set, this property may be set to
prevent the value icons from showing up next to the form items value
'show edges'
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides).
'tab picker button'
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible 'tabBarPosition'
based on the pickerButtonSrc
property for this tabSet.
'tab scroller buttons'
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible 'tabBarPosition'
based on the scrollerSrc
property for this tabSet.
'Smart GWT SQL engine'
for persistence, what
database table name to use.
pane
to an existing tab in this tabSet
pane
to an existing tab in this tabSet
useTextField
is true
this
property governs the alignment of text within the text field.
com.smartgwt.client..SimpleTile
, CSS style for each value shown within a tile.
Canvas.setPrompt(String)
"Submit"
by default.
Tree
.
TreeNode
that holds the title of the node as it
should be shown to the user.
titleStyle
, can set to provide a separate style
for the title text.
showToolbar
, if shown.
Canvas.setPrompt(String)
position
property).
position
property).
topOperator
for
this FilterBuilder.
CalendarEvent
.
treeField: true
will display the Tree
.
'headerContextMenu'
for
this grid and 'this.canFreezeFields'
is true, this
string will be shown as the title for the menu item to unfreeze a currently frozen field.
'headerContextMenu'
for
this grid, and 'this.isGrouped'
is true, this attribute
will be shown as the title for the menu item to ungroup the grid.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set? This attribute will be passed to DataSource#getUpdatedData
as the useDataFromRequest
parameter.
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
display of individual fields, without having to list the entire set of fields that
should be shown.
useFlatFields
, but applies to all DataBound
components that bind to this DataSource.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML
message to send to the web service, properties in
'request.data'
will be used as the values for XML elements of the same name, at
any level of nesting.
useFlatFields
on an operationBinding is equivalent to setting useFlatFields
on all DataSource requests with the same operationType
as this operationBinding
.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML message to send to the web service, properties in
data
will be used as the values for XML elements of the same name, at
any level of nesting.
useFlatFields
flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
'useFlatFields'
XML serialization behavior to be
used for all soap headers in the request.
useHttpProxy
, but serves as a default for this
DataSource that may be overriden by individual operationBindings.
com.smartgwt.client.rpc.RPCManager#sendProxied
servlet to send requests described by this
operationBinding.
useTextField
is not false
this
property determines if an input mask should be used.
displayFormat
.
fields
from another DataSource
(via inheritsFrom
), indicates that the parent's field order
should be used instead of the order of the fields as declared in this DataSource.
validators
for this field will
be run whenever the value of the field is changed.
com.smartgwt.client..ValidatorTypes#hasRelatedRecord
validator to every field on this dataSource that has a 'foreignKey'
defined.
Validator
objects for this field.
type
to be "header", the
value of this attribute specifies the header text.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an optionDataSource
, this property denotes
the the field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an 'optionDataSource'
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
optionDataSource
field used to
retrieve the stored values that are to be mapped to the display values (specified by displayField
).
FormItemValueFormatter
, if provided, is evaluated to get the
display value to show for this form items underlying data value.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
is specified, use this property to
specify a height for the value icon written out.
valueIconLeftPadding
valueIconRightPadding
valueIcons
is specified, this property may be
used to specify both the width and height of the icon written out.
valueIcons
is specified, use this property to
specify a width for the value icon written out.
valueMap
.
valueMap
.
com.smartgwt.client.widgets.grid.ListGrid#setEditorValueMap
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap
methods which allow further
customization of the valueMap displayed while the field is in edit mode.
com.smartgwt.client.widgets.grid.ListGrid#setEditorValueMap
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap
methods which allow further
customization of the valueMap displayed while the field is in edit mode.
canEdit
, canEdit
), editors displayed for this
field will pick up their valueMap either from this value or from editorValueMap
.
canEdit
, canEdit
), editors displayed for this
field will pick up their valueMap either from this value or from editorValueMap
.
ValuesManager
for managing values displayed in this component.
Tree
of options from which the user can select.
String
object passed in.ListGrid.getViewState()
.
vertical
is true, and src
is unset.
vertical
is true and src
is unset.
vertical
is true and src
is unset.
showWorkday
is set, style used for cells that
are within the workday, as defined by workdayStart
and workdayEnd
.
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to com.smartgwt.client..Time#parseInput
.
showWorkday
is true
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to com.smartgwt.client..Time#parseInput
.
DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
should serialize this value as an XML attribute.
resultType
parameter of WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)
, if resultType is an
XPath.
recordXPath
mapping to the data node of XML returned by the server.
Applies if this.dataFormat is set
to "xml"
.dismissOnEscape
is set, just
return it.
DynamicForm.setErrors(java.util.Map, boolean)
or
DynamicForm.validate(boolean)
.
com.smartgwt.client.widgets.form.ValuesManager#handleHiddenValidationErrors
to allow custom handling of hidden errors.
FormItem.show()
Slider
component to present an interface for picking from
either a continuous range or a range with a small number of discrete values.Splitbar
class that uses the grip
functionality to show
a stateful open / close indicator.StretchImg
class.RPCManager
for more information on these codessubmit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
submit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
submit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
submit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
submit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
submit()
is automatically called when a SubmitItem
included in the form is clicked, or, if saveOnEnter
is set, when the "Enter" key is pressed in a text input.
action
,
identically to how a plain HTML <form> element would submit data, as either an HTTP GET or POST as specified by
method
.
DynamicForm.submit()
when
clicked.callback
in the
transaction won't fire, and the transaction can never timeout
.
callback
in
the transaction won't fire, and the transaction can never timeout
.
<TEXTAREA>
object)DataBoundComponent
that displays a list of objects as a set of
"tiles", where each tile represents one object, and the tiles are laid out in a grid with multiple tiles per row.ImgButton
, 'radio
button groups'
, MenuButton
, ComboBoxItem
, LayoutSpacer
, Label
and SelectItem
.dataURL
.
Tree
class, which manipulates hierarchical data sets
the TreeGrid widget class, which extends the ListGrid class to visually present tree data in an
expandable/collapsible format.TreeGrid
.StringUtil.asHTML(String)
.
Page.registerKey(String, KeyCallback)
method.
Canvas.handleHover()
), this method
can be called to update the contents of the hover.
Canvas.handleHover()
), this method
can be called to update the contents of the hover.
textBoxStyle
).
Slider.addValueChangedHandler(com.smartgwt.client.widgets.events.ValueChangedHandler)
handler to determine whether
the value change is due to an ongoing drag interaction (true) or due to a thumb-release, mouse click, keypress, or
programmatic event (false).
rememberValues()
method.
rememberValues()
method.
Canvas.willAcceptDrop()
and works as follows:Canvas.willAcceptDrop()
(the superclass definition) returns false, this method
always returns false.
ListGrid.willAcceptDrop()
and works as follows: ListGrid.willAcceptDrop()
(the superclass definition) is consulted.
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match (from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed a certain set of criteria.
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match (from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed a certain set of criteria.
RPCTransport
transport
for cross-domain
calls to JSON services, such as those provided by Yahoo!.
|
|||||||||
PREV NEXT | FRAMES NO FRAMES |