|
|||||||||
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
data
attribute is a
com.smartgwt.client.data.ResultSet
.
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
.
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
.
Returning false will suppress the standard button click handling code.
keyPress
on the form item icon directly.
formItem.itemHoverHTML()
/
form.itemHoverHTML()
.
canFocus
: true).
canFocus
:
true).
mouseStillDownDelay
by default) when the system is idle -
i.e.
TreeGrid.addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler)
instead.
com.smartgwt.client..SummaryBuilder
to create a new Summary Field.
icon
.
formItem.titleHoverHTML()
/
form.titleHoverHTML()
.
'SQL engine'
.
<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.
com.smartgwt.client.widgets.form.fields.FormItem#clearValue
if appropriate.
If there is no item associated with the field name, the field will just be cleared within
our stored set of values.
iconClick
method will be fired instead (if
specified).
com.smartgwt.client.widgets.Canvas#showClickMask
to determine the masks
behavior
when clicked.'SmartGWT server'
.
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.
the ColumnTree widget class, which visually
presents tree data in a so-called
"Miller Column" format.
For information on DataBinding Trees, see TreeDataBinding
.
substring
.ControlNames
are strings used to specify which UI controls should appear
in the editor
toolbar.'operation'
that acts on the set
of stored objects represented by a DataSource
, performing one of the basic actions
that makes sense on a set of similar records: "fetch", "add", "update" or "remove".DateItem
class.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.
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
.
true
.
Override to do something else.
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.
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.
edgeStyleName
will be treated as a base style name and
appended with following suffixes to support separate styling per cell:
true
, false
and unset.
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?
animateRemoveRecord
, this property
designates the speed of the animation in pixels per second.
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
.
name
for any
field that does not have a 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()
autoFetchAsFilter
for details.
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
set for a ListGrid field.
optionDataSource
is set
for this field.
autoFitData
is set to "horizontal"
or "both"
this property provides the maximum number of columns for which the ListGrid will expand.
If more columns are present, scrolling will be introduced to reach them as normal.
If unset the ListGrid will expand to accomodate as many columns as are defined for the
grid.
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.
autoCenterOnShow
, it either reappears wherever it was last shown after hide/show(),
or centered regardless of where it was last shown.
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
recordBaseStyleProperty
instead.
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
.
Note: If booleanTrueImage
is unset, the checkedImage
will be used to indicate a true value in a boolean field.
ID
.
scriptInclude
transport, this attribute specifies the
name of the parameter from which the server expects to read the name of the JavaScript
callback function.
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.
dynamicForm.canFocus
to false will have no effect on
whether form items within the form may recieve focus.
this.canAcceptDroppedRecords
is true, we
allow nodes to be dragged to different folders.
DynamicForm.submit()
will perform a native HTML submission
to the specified action
URL.'DataBound Component Methods'
to send data to
the server as they provide a far more sophisticated interface, with built in
options for server validation, required fields, etc.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.
If unset, the booleanFalseImage
will be used.
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.
If unset, the booleanTrueImage
will be used.
showValueIconOver
et al are set, the
state ("Over"
, "Down"
and "Disabled"
) will be
added to this name as the user intereacts with the checkbox, as well as the
".gif"
extension
childrenProperty
directly on
the childrenField object.
childrenField
to this field's
name.
snapToGrid
or
snapResizeToGrid
value on the child.
snapToGrid
value on the child.
multiple
, controls the name of the XML tag used for each
subelement during DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
.
clientOnly
DataSource.
folderIcon
for closed folders.
If showOpenIcons
is set to false
this suffix will also be
appended to open folders' icons.
folderIcon
for closed folders.
If showOpenIcons
is set to false
this suffix will also be
appended to open folders' icons.
canClose
and canCloseTabs
.
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.
Connector icons are rendered into the title field of each row and show the dotted
hierarchy lines between siblings of the same parent node.
'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.
com.smartgwt.client.data.ResultSet
cache should be dropped when the
criteria
changes
DynamicForm.getValuesAsCriteria()
.
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
drop state icon (with dropIconSuffix
) should be displayed when the
user drop-hovers over this folder.node[treeGrid.customIconDropProperty]
to true to show the drop state
icons, or false to suppress this.treeGrid.showCustomIconDrop
for this node.
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
open state icon should be displayed when the folder is open.
Set node[treeGrid.customIconOpenProperty]
to true to show the open state
icons, or false to suppress this.grid.showCustomIconOpen
for this node.
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
open state icon should be displayed when the folder is open.
Set node[treeGrid.customIconOpenProperty]
to true to show the open state
icons, or false to suppress this.grid.showCustomIconOpen
for this node.
node[grid.customIconProperty]
to the URL of the desired icon to display and
it will be shown instead of the standard nodeIcon
for this node.showCustomIconOpen
is true for this grid, customized icons for folder nodes will be appended with the
openIconSuffix
suffix on state change,
as with the standard folderIcon
.
node[grid.customIconProperty]
to the URL of the desired icon to display and
it will be shown instead of the standard nodeIcon
for this node.showCustomIconOpen
and/or showCustomIconDrop
is true for this grid, customized icons for folder nodes will be appended with the
dropIconSuffix
or openIconSuffix
suffixes on state change
as with the standard folderIcon
for this treeGrid.
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).
DSRequest
.
DSRequest
.
DSRequest
.
DSRequest
.
'SmartGWT SQL engine'
for
persistence, which database configuration to use.
groupingMode
is unset.
See groupingModes
.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to the height of the
header when minimized.
defaultMinimizeHeight
will be used instead.
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.
If this property is true, but destroyed
is not, this indicates the canvas is
in the process of being destroyed.
BaseWidget.destroy()
should be called on pane
when it a tab is
removed via TabSet.removeTab(int)
}.
DataBoundComponent
.
com.smartgwt.client..Date#weekendDays
.
confirmDiscardEdits
is true this is the title for the save button
appearing in the lost edits confirmation dialog.
modelType
, 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
.optionDataSource
is defined for the field, the cell will display
the displayField value for the current record instead of the underlying value for
this field.
displayField
for this form item.
If unset, and optionDataSource
is explicitly specified, this method
will return the title field for the optionDataSource
displayField
for this form item.
If unset, and optionDataSource
is explicitly specified, this method
will return the title field for the optionDataSource
displayField
for this form
item.
displayField
for this form item.
If unset, and optionDataSource
is explicitly specified, this method
will return the title field for the optionDataSource
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.
Default setting is "toShortDate"
which ensures that if the standard
shortDate format is modified via com.smartgwt.client..Date#setShortDisplayFormat
this format
will be picked up.
"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.
canDropComponents
is true, this method will be called when a component is
dropped onto the layout to determine what component to add as a new layout member.
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.editPendingCSSText
Note : This method should be called only after the widget has been rendered.
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
.
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.autoSaveEdits
is true, this may cause a save of the current edit values
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?
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.
title
attribute on the field to specify the title.
showHeaderContextMenu
for this grid, and
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.
This avoids the need to perform fetches each time setValue() is called with a new 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).
canAddFormulaFields
.
showHeaderContextMenu
for this grid and
canFreezeFields
is true, this string will be shown as the
title for the menu item to freeze a currently unfrozen field.
showHeaderContextMenu
for this grid and
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.
showHeaderContextMenu
for this grid and
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.
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.
showHeaderContextMenu
for this grid and
canGroupBy
is true, this string will be shown as the
title for the menu item to toggle the group by setting for a field.
groupingModes
,
the current grouping mode.
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.
Note that depending on the headerButtonConstructor
of the header
buttons you may also need to set headerTitleStyle
.
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
headerSpans
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.
Note that this will typically only have an effect if
headerButtonConstructor
is set to StretchImgButton
or a subclass
thereof.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass
thereof.
iconHeight
property will be used instead.
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.
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.
TabSet.selectTab(int)
, TabSet.updateTab(int, com.smartgwt.client.widgets.Canvas)
, TabSet.removeTab(int)
].TabSet.addTabSelectedHandler(com.smartgwt.client.widgets.tab.events.TabSelectedHandler)
and TabSet.addTabDeselectedHandler(com.smartgwt.client.widgets.tab.events.TabDeselectedHandler)
handler functions, if specified.
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).
imageSize
.
valueIcons
when determining the
URL for the image.
Will not be applied if the valueIcon
URL is absolute.
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 inheritsFrom
from
another schema can be redeclared with this property set in order to indicate that the
property should not be used.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
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.
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
class, this method will not return an
item by index
items
.
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).
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?managePercentBreadth
:true.
menu.showAnimationEffect
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.
serverMethod
using this attribute.
defaultMinimizeHeight
canvas.animationTime
.
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.
{baseName}.{extension}
,
{baseName}_opened.{extension}
will be displayed next to opened folders, and
{baseName}_closed.{extension}
will be displayed next to closed folders, or
if this page is in RTL mode, {baseName}_opened_rtl.{extension}
and
{baseName}_closed_rtl.{extension}
will be used.
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)
consules to determine if the
node is open or not.
String
object.TreeGrid.getOpenState()
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.
showOtherDays
is false.
Other...
item.
Other...
item.
"<b>AAA</b>"
) is displayed
to the user rather than the interpreted HTML (for example "AAA"
)
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.
padding
or in the
CSS style applied to this layout), should it show up as space outside the members,
similar to layoutMargin?
padding
or in the
CSS style applied to this layout), should it show up as space outside the members,
similar to layoutMargin?
([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.
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).
If unspecified drawAheadRatio
will be used in all cases
com.smartgwt.client.widgets.grid.ListGrid#getCellRecord
.
record[listGrid.recordBaseStyleProperty]
to the desired base style name -
for example if recordBaseStyleProperty
is "_baseStyle"
, set
record._baseStyle
to the custom base style name.
recordXPath
.
xmlRecordXPath
or
jsonRecordXPath
is used by default based on the dataFormat
setting.
canRemoveRecords
is enabled, default icon to show in
the auto-generated field that allows removing records.
idField
as an existing node, the existing node is removed when
the new node is added.
DataSourceField
, enabling both client and server side validation.
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.
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.
com.smartgwt.client.widgets.form.FilterBuilder#search
method.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
This property is automatically set on a call to DynamicForm.editRecord(com.smartgwt.client.data.Record)
or
DynamicForm.editNewRecord()
, or may be set directly via
DynamicForm.setSaveOperationType(com.smartgwt.client.types.DSOperationType)
.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
This property is automatically set on a call to DynamicForm.editRecord(com.smartgwt.client.data.Record)
or
DynamicForm.editNewRecord()
, or may be set directly via
DynamicForm.setSaveOperationType(com.smartgwt.client.types.DSOperationType)
.
showTabScroller
is true, this property governs the size of scroller
buttons.
showTabScroller
, 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"].
showTabScroller
, and
symmetricScroller
is false, this property governs the base
URL for the tab bar back and forward scroller button images.
showTabScroller
, 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"].
workdayStart
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).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
with a field of type
"sequence", the name of the SQL sequence that should be used when inserting new records into
this table.
com.smartgwt.client..ServerObject
for this operationBinding.
callback
as data
.
DynamicForm.getValues()
?
separatorRows
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
),
show drop state images when the user is drop-hovering over the folder.
If true, the dropIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_drop.gif"
).customIconDropProperty
property.
customIconProperty
),
show open state images when the folder is opened.
If true, the openIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_open.gif"
).closedIconSuffix
is never appended to custom folder icons.customIconOpenProperty
property.
customIconProperty
),
show open state images when the folder is opened.
If true, the openIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_open.gif"
).closedIconSuffix
is never appended to custom folder icons.customIconOpenProperty
property.
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.
dropIconSuffix
onto the
folderIcon
URL (for example "[SKIN]/folder.gif"
may be
replaced by "[SKIN]/folder_drop.gif"
).
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.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
canFilter
fields
specified on the dataSource will not be shown unless explicitly included in this component's
fields
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.
If this property is unset, default behavior is to show focused state when the item
recieves focus.
showConnectors
is true, this property determines whether we should show
showing vertical continuation lines for each level of indenting within the tree.
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
open
folders than closed folders.
This is achieved by appending the openIconSuffix
onto the
folderIcon
URL [for example "[SKIN]/folder.gif"
might be
replaced by "[SKIN]/folder_open.gif"
.false
the same icon is shown for
open folders as for closed folders, unless a custom folder icon was specified.
open
folders than closed folders.
This is achieved by appending the openIconSuffix
onto the
folderIcon
URL [for example "[SKIN]/folder.gif"
might be
replaced by "[SKIN]/folder_open.gif"
.false
the same icon is shown for
open folders as for closed folders, unless a custom folder icon was specified.
valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
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.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
Over
state?
overCanvas
on user rollover.
showOver
property.
showEdges
.
showEdges
, 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 combo?
showPrompt
if it's unset.
showFooter
) and canDragResize
is true.
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).
singleCellValueProperty
.
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.
snapToGrid
value if undefined.
masterElement
(if specified), or its
parentElement
.
showHeaderContextMenu
for this grid, this
attribute will be shown as the menu item title to sort a field in ascending order.
showHeaderContextMenu
for this grid, this
attribute will be shown as the menu item title to sort a field in descending order.
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).serviceNamespace
, 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.
defaultIconSrc
property will be used
instead.defaultIconSrc
this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state.
memberOverlap
, controls the z-stacking order of
members.
CalendarEvent
The name of this field within the CalendarEvent can be changed via
startDateField
CalendarEvent
.
baseStyle
as the component changes state and/or is selected.
canAddSummaryFields
.
title
.
valueIcons
is set, this property may be set to prevent the value
icons from showing up next to the form items value
showPaneContainerEdges
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).
showTabPicker
, 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.
showTabScroller
, 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.
canvas.tabIndex
cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR
- as we reserve the values above this range for
auto-assigned tab-indices.
'SmartGWT SQL engine'
for
persistence, what database table name to use.
useTextField
is true
this property governs the alignment
of text within the text field.
{baseName}.{extension}
h{baseName}.{extension}
: default enabled appearance.
h{baseName}_down.{extension}
: appearance when the slider is enabled and the
thumb is clicked.
h{baseName}_off.{extension}
: appearance when the slider is disabled.
For vertical sliders:
v{baseName}.{extension}
: default enabled appearance.
v{baseName}_down.{extension}
: appearance when the slider is enabled and the
thumb is clicked.
v{baseName}_off.{extension}
: appearance when the slider is disabled.
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.
showHeaderContextMenu
for this grid and
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).
{baseName}.{extension}
h{baseName}_start.{extension}
: start (left edge) of the track for a slider
that is enabled.
h{baseName}_stretch.{extension}
: the track for an enabled slider; this may
be centered, tiled, or stretched.
h{baseName}_end.{extension}
: end (right edge) of the track for a slider
that is enabled.
h{baseName}_off_start.{extension}
: start (left edge) of the track for a slider
that is disabled.
h{baseName}_off_stretch.{extension}
: the track for a disabled slider; this
may be centered, tiled, or stretched.
h{baseName}_off_end.{extension}
: end (right edge) of the track for a slider
that is disabled.
For vertical sliders:
v{baseName}_start.{extension}
: start (bottom edge) of the track for a slider
that is enabled.
v{baseName}_stretch.{extension}
: the track for an enabled slider; this may
be centered, tiled, or stretched.
v{baseName}_end.{extension}
: end (top edge) of the track for a slider
that is enabled.
v{baseName}_off_start.{extension}
: start (bottom edge) of the track for a slider
that is disabled.
v{baseName}_off_stretch.{extension}
: the track for a disabled slider; this
may be centered, tiled, or stretched.
v{baseName}_off_end.{extension}
: end (top edge) of the track for a slider
that is disabled.
CalendarEvent
.
RPCManager.sendQueue()
containing the
RPCRequest
associated with this response.
treeField: true
will display the Tree
.
showHeaderContextMenu
for this grid and
canFreezeFields
is true, this string will be shown as the
title for the menu item to unfreeze a currently frozen field.
showHeaderContextMenu
for this grid, and
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"
.
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
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
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.
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.
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.
If unset, default behavior will return the name
of this field.
valueField
for this item.
If unset, default behavior will return the name
of this field.
valueField
for this item.
valueField
for this item.
If unset, default behavior will return the name
of this field.
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.
valueIconSize
.
Can be overridden at the field level
valueIconSize
, valueIconHeight
, and
valueIconSize
.
valueIconLeftPadding
showValueIconOnly
is true
valueIconRightPadding
valueIcons
is specified, this property may be used to specify both
the width and height of the icon written out.
Note that valueIconWidth
and valueIconHeight
take
presidence over this value, if specified.
valueIconWidth
and
valueIconHeight
, or at the field level via valueIconSize
,
valueIconWidth
and {ListGridField.valueIconHeight}
valueIconWidth
and {ListGridField.valueIconHeight}
valueIcons
is specified, use this property to specify a width for
the value icon written out.
valueIconSize
.
Can be overridden at the field level
valueIconSize
, valueIconWidth
, and
valueIconSize
.
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.
Returns an integer indicating how far the mouse wheel was rotated.
iconWidth
property will be used instead.
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
.
wrapItemTitles
at the DynamicForm level.
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
.this.hover()
(if defined), and handle
showing the hover canvas if this.showHover
is true.
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)
.
Criteria
objects,
and results returned via a SmartGWT DSResponse.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".
'server
integration'
materials is recommended to get an overview.
saveOperationType
is currently "add".
saveOperationType
is currently "add".
iconKeyPress
method will be fired instead
(if specified).
canFocus
: true).
align
contents
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.false
.
Override to do something else.
saveData()
, hide the Dialog, then return
true
.
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()
.
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
s as selected and retrieving the selected record or records.
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.
'install'
the 'SmartGWT Java
Server'
into any J2SE/J2EE environment
You 'create DataSources'
in either XML or JavaScript,
possibly on-the-fly from 'existing metadata'
.edgeStyleName
will be treated as a base style name and
appended with following suffixes to support separate styling per cell:
true
, false
and unset.
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?
animateRemoveRecord
, this property
designates the speed of the animation in pixels per second.
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?
contentsURL
, ViewLoader
,
XML or JSON flat data files, videos, etc.
contentsURL
, 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
.
name
for any
field that does not have a 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()
autoFetchAsFilter
for details.
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
set for a ListGrid field.
optionDataSource
is set
for this field.
autoFitData
is set to "horizontal"
or "both"
this property provides the maximum number of columns for which the ListGrid will expand.
If more columns are present, scrolling will be introduced to reach them as normal.
If unset the ListGrid will expand to accomodate as many columns as are defined for the
grid.
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.
autoCenterOnShow
, it either reappears wherever it was last shown after hide/show(),
or centered regardless of where it was last shown.
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
recordBaseStyleProperty
instead.
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
.
Note: If booleanTrueImage
is unset, the checkedImage
will be used to indicate a true value in a boolean field.
scriptInclude
transport, this attribute specifies the
name of the parameter from which the server expects to read the name of the JavaScript
callback function.
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.
dynamicForm.canFocus
to false will have no effect on
whether form items within the form may recieve focus.
this.canAcceptDroppedRecords
is true, we
allow nodes to be dragged to different folders.
DynamicForm.submit()
will perform a native HTML submission
to the specified action
URL.'DataBound Component Methods'
to send data to
the server as they provide a far more sophisticated interface, with built in
options for server validation, required fields, etc.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.
If unset, the booleanFalseImage
will be used.
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.
If unset, the booleanTrueImage
will be used.
showValueIconOver
et al are set, the
state ("Over"
, "Down"
and "Disabled"
) will be
added to this name as the user intereacts with the checkbox, as well as the
".gif"
extension
childrenProperty
directly on
the childrenField object.
childrenField
to this field's
name.
snapToGrid
or
snapResizeToGrid
value on the child.
snapToGrid
value on the child.
multiple
, controls the name of the XML tag used for each
subelement during DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)
.
folderIcon
for closed folders.
If showOpenIcons
is set to false
this suffix will also be
appended to open folders' icons.
folderIcon
for closed folders.
If showOpenIcons
is set to false
this suffix will also be
appended to open folders' icons.
canClose
and canCloseTabs
.
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.
Connector icons are rendered into the title field of each row and show the dotted
hierarchy lines between siblings of the same parent node.
'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.
com.smartgwt.client.data.ResultSet
cache should be dropped when the
criteria
changes
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
drop state icon (with dropIconSuffix
) should be displayed when the
user drop-hovers over this folder.node[treeGrid.customIconDropProperty]
to true to show the drop state
icons, or false to suppress this.treeGrid.showCustomIconDrop
for this node.
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
open state icon should be displayed when the folder is open.
Set node[treeGrid.customIconOpenProperty]
to true to show the open state
icons, or false to suppress this.grid.showCustomIconOpen
for this node.
customIconProperty
),
this property allows the developer to specify on a per-node basis whether a
open state icon should be displayed when the folder is open.
Set node[treeGrid.customIconOpenProperty]
to true to show the open state
icons, or false to suppress this.grid.showCustomIconOpen
for this node.
node[grid.customIconProperty]
to the URL of the desired icon to display and
it will be shown instead of the standard nodeIcon
for this node.showCustomIconOpen
is true for this grid, customized icons for folder nodes will be appended with the
openIconSuffix
suffix on state change,
as with the standard folderIcon
.
node[grid.customIconProperty]
to the URL of the desired icon to display and
it will be shown instead of the standard nodeIcon
for this node.showCustomIconOpen
and/or showCustomIconDrop
is true for this grid, customized icons for folder nodes will be appended with the
dropIconSuffix
or openIconSuffix
suffixes on state change
as with the standard folderIcon
for this treeGrid.
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).
DSRequest
.
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().
'SmartGWT SQL engine'
for
persistence, which database configuration to use.
groupingMode
is unset.
See groupingModes
.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to the height of the
header when minimized.
defaultMinimizeHeight
will be used instead.
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
.
com.smartgwt.client..Date#weekendDays
.
confirmDiscardEdits
is true this is the title for the save button
appearing in the lost edits confirmation dialog.
modelType
, 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
.optionDataSource
is defined for the field, the cell will display
the displayField value for the current record instead of the underlying value for
this field.
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.
Default setting is "toShortDate"
which ensures that if the standard
shortDate format is modified via com.smartgwt.client..Date#setShortDisplayFormat
this format
will be picked up.
"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.
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
.
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.autoSaveEdits
is true, this may cause a save of the current edit values
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?
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()
.
showHeaderContextMenu
for this grid, and
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.
This avoids the need to perform fetches each time setValue() is called with a new 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).
showHeaderContextMenu
for this grid and
canFreezeFields
is true, this string will be shown as the
title for the menu item to freeze a currently unfrozen field.
showHeaderContextMenu
for this grid and
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.
showHeaderContextMenu
for this grid and
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.
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.
showHeaderContextMenu
for this grid and
canGroupBy
is true, this string will be shown as the
title for the menu item to toggle the group by setting for a field.
groupingModes
,
the current grouping mode.
baseStyle
to apply to the buttons in the header, and the sorter, for
this ListGrid.
Note that depending on the headerButtonConstructor
of the header
buttons you may also need to set headerTitleStyle
.
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
headerSpans
with no height specified.
headerSpans
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.
Note that this will typically only have an effect if
headerButtonConstructor
is set to StretchImgButton
or a subclass
thereof.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass
thereof.
iconHeight
property will be used instead.
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.
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.
TabSet.selectTab(int)
, TabSet.updateTab(int, com.smartgwt.client.widgets.Canvas)
, TabSet.removeTab(int)
].TabSet.addTabSelectedHandler(com.smartgwt.client.widgets.tab.events.TabSelectedHandler)
and TabSet.addTabDeselectedHandler(com.smartgwt.client.widgets.tab.events.TabDeselectedHandler)
handler functions, if specified.
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).
imageSize
.
valueIcons
when determining the
URL for the image.
Will not be applied if the valueIcon
URL is absolute.
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 inheritsFrom
from
another schema can be redeclared with this property set in order to indicate that the
property should not be used.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
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.
true
to explicitly mark this node as a folder.
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.
items
.
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).
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?menu.showAnimationEffect
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.
serverMethod
using this attribute.
defaultMinimizeHeight
canvas.animationTime
.
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.
{baseName}.{extension}
,
{baseName}_opened.{extension}
will be displayed next to opened folders, and
{baseName}_closed.{extension}
will be displayed next to closed folders, or
if this page is in RTL mode, {baseName}_opened_rtl.{extension}
and
{baseName}_closed_rtl.{extension}
will be used.
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)
consules 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
.
optionDataSource
.
valueField
and
displayField
in the loaded records,
to derive one valueMap entry per record loaded from the optionDataSource.
showOtherDays
is false.
Other...
item.
Other...
item.
"<b>AAA</b>"
) is displayed
to the user rather than the interpreted HTML (for example "AAA"
)
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.
padding
or in the
CSS style applied to this layout), should it show up as space outside the members,
similar to layoutMargin?
padding
or in the
CSS style applied to this layout), should it show up as space outside the members,
similar to layoutMargin?
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.
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).
If unspecified drawAheadRatio
will be used in all cases
record[listGrid.recordBaseStyleProperty]
to the desired base style name -
for example if recordBaseStyleProperty
is "_baseStyle"
, set
record._baseStyle
to the custom base style name.
recordName
.
ListGrid.setData(ListGridRecord[])
recordXPath
.
xmlRecordXPath
or
jsonRecordXPath
is used by default based on the dataFormat
setting.
canRemoveRecords
is enabled, default icon to show in
the auto-generated field that allows removing records.
idField
as an existing node, the existing node is removed when
the new node is added.
DSRequest
s made by this DataSource.
DSRequest
created for this operation.
DataSourceField
, enabling both client and server side validation.
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.
com.smartgwt.client.widgets.form.FilterBuilder#search
method.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
This property is automatically set on a call to DynamicForm.editRecord(com.smartgwt.client.data.Record)
or
DynamicForm.editNewRecord()
, or may be set directly via
DynamicForm.setSaveOperationType(com.smartgwt.client.types.DSOperationType)
.
DSOperationType
to be performed when DynamicForm.saveData()
is called.
This property is automatically set on a call to DynamicForm.editRecord(com.smartgwt.client.data.Record)
or
DynamicForm.editNewRecord()
, or may be set directly via
DynamicForm.setSaveOperationType(com.smartgwt.client.types.DSOperationType)
.
showTabScroller
is true, this property governs the size of scroller
buttons.
showTabScroller
, 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"].
showTabScroller
, and
symmetricScroller
is false, this property governs the base
URL for the tab bar back and forward scroller button images.
showTabScroller
, 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"].
workdayStart
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()
.
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
with a field of type
"sequence", the name of the SQL sequence that should be used when inserting new records into
this table.
com.smartgwt.client..ServerObject
for this operationBinding.
callback
as data
.
DynamicForm.getValues()
?
separatorRows
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
),
show drop state images when the user is drop-hovering over the folder.
If true, the dropIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_drop.gif"
).customIconDropProperty
property.
customIconProperty
),
show open state images when the folder is opened.
If true, the openIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_open.gif"
).closedIconSuffix
is never appended to custom folder icons.customIconOpenProperty
property.
customIconProperty
),
show open state images when the folder is opened.
If true, the openIconSuffix
will be appended to the image URL
(so "customFolder.gif"
might be replaced with
"customFolder_open.gif"
).closedIconSuffix
is never appended to custom folder icons.customIconOpenProperty
property.
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.
dropIconSuffix
onto the
folderIcon
URL (for example "[SKIN]/folder.gif"
may be
replaced by "[SKIN]/folder_drop.gif"
).
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.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
showErrorIcons
,
showErrorText
, and
showErrorStyle
control how validation errors are
displayed next to form items when showInlineErrors
is true.
These properties are boolean values, and can be set on a DynamicForm to control the
behavior form-wide, or set on individual FormItems.
canFilter
fields
specified on the dataSource will not be shown unless explicitly included in this component's
fields
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.
If this property is unset, default behavior is to show focused state when the item
recieves focus.
showConnectors
is true, this property determines whether we should show
showing vertical continuation lines for each level of indenting within the tree.
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
open
folders than closed folders.
This is achieved by appending the openIconSuffix
onto the
folderIcon
URL [for example "[SKIN]/folder.gif"
might be
replaced by "[SKIN]/folder_open.gif"
.false
the same icon is shown for
open folders as for closed folders, unless a custom folder icon was specified.
open
folders than closed folders.
This is achieved by appending the openIconSuffix
onto the
folderIcon
URL [for example "[SKIN]/folder.gif"
might be
replaced by "[SKIN]/folder_open.gif"
.false
the same icon is shown for
open folders as for closed folders, unless a custom folder icon was specified.
valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
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.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
Over
state?
overCanvas
on user rollover.
showOver
property.
showEdges
.
showEdges
, 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 combo?
showPrompt
if it's unset.
showFooter
) and canDragResize
is true.
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).
singleCellValueProperty
.
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.
snapToGrid
value if undefined.
masterElement
(if specified), or its
parentElement
.
showHeaderContextMenu
for this grid, this
attribute will be shown as the menu item title to sort a field in ascending order.
showHeaderContextMenu
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()
.
serviceNamespace
, 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.
defaultIconSrc
property will be used
instead.defaultIconSrc
this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state.
memberOverlap
, controls the z-stacking order of
members.
CalendarEvent
The name of this field within the CalendarEvent can be changed via
startDateField
CalendarEvent
.
title
.
valueIcons
is set, this property may be set to prevent the value
icons from showing up next to the form items value
showPaneContainerEdges
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).
showTabPicker
, 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.
showTabScroller
, 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.
canvas.tabIndex
cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR
- as we reserve the values above this range for
auto-assigned tab-indices.
'SmartGWT 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.
{baseName}.{extension}
h{baseName}.{extension}
: default enabled appearance.
h{baseName}_down.{extension}
: appearance when the slider is enabled and the
thumb is clicked.
h{baseName}_off.{extension}
: appearance when the slider is disabled.
For vertical sliders:
v{baseName}.{extension}
: default enabled appearance.
v{baseName}_down.{extension}
: appearance when the slider is enabled and the
thumb is clicked.
v{baseName}_off.{extension}
: appearance when the slider is disabled.
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).
topOperator
for
this FilterBuilder.
{baseName}.{extension}
h{baseName}_start.{extension}
: start (left edge) of the track for a slider
that is enabled.
h{baseName}_stretch.{extension}
: the track for an enabled slider; this may
be centered, tiled, or stretched.
h{baseName}_end.{extension}
: end (right edge) of the track for a slider
that is enabled.
h{baseName}_off_start.{extension}
: start (left edge) of the track for a slider
that is disabled.
h{baseName}_off_stretch.{extension}
: the track for a disabled slider; this
may be centered, tiled, or stretched.
h{baseName}_off_end.{extension}
: end (right edge) of the track for a slider
that is disabled.
For vertical sliders:
v{baseName}_start.{extension}
: start (bottom edge) of the track for a slider
that is enabled.
v{baseName}_stretch.{extension}
: the track for an enabled slider; this may
be centered, tiled, or stretched.
v{baseName}_end.{extension}
: end (top edge) of the track for a slider
that is enabled.
v{baseName}_off_start.{extension}
: start (bottom edge) of the track for a slider
that is disabled.
v{baseName}_off_stretch.{extension}
: the track for a disabled slider; this
may be centered, tiled, or stretched.
v{baseName}_off_end.{extension}
: end (top edge) of the track for a slider
that is disabled.
CalendarEvent
.
treeField: true
will display the Tree
.
showHeaderContextMenu
for this grid and
canFreezeFields
is true, this string will be shown as the
title for the menu item to unfreeze a currently frozen field.
showHeaderContextMenu
for this grid, and
isGrouped
is true, this
attribute will be shown as the title for the menu item to ungroup the grid.
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
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
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.
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.
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
).
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.
valueIconSize
.
Can be overridden at the field level
valueIconSize
, valueIconHeight
, and
valueIconSize
.
valueIconLeftPadding
showValueIconOnly
is true
valueIconRightPadding
valueIcons
is specified, this property may be used to specify both
the width and height of the icon written out.
Note that valueIconWidth
and valueIconHeight
take
presidence over this value, if specified.
valueIconWidth
and
valueIconHeight
, or at the field level via valueIconSize
,
valueIconWidth
and {ListGridField.valueIconHeight}
valueIconWidth
and {ListGridField.valueIconHeight}
valueIcons
is specified, use this property to specify a width for
the value icon written out.
valueIconSize
.
Can be overridden at the field level
valueIconSize
, valueIconWidth
, and
valueIconSize
.
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.
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
.
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.
iconWidth
property will be used instead.
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
.
wrapItemTitles
at the DynamicForm level.
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"
.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.
DynamicForm.setFieldErrors(java.lang.String, java.lang.String, boolean)
/
com.smartgwt.client.widgets.form.DynamicForm#addFieldErrors
/ DynamicForm.clearFieldErrors(java.lang.String, boolean)
.DynamicForm.showErrors()
.
com.smartgwt.client.widgets.form.ValuesManager#handleHiddenValidationErrors
will be fired 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.
DynamicForm.submit()
for details on how to control what happens when a form is
submitted.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
,
radioGroup
, MenuButton
,
ComboBoxItem
, LayoutSpacer
, Label
and
SelectItem
.dataURL
.
TreeGrid
component is a visual representation of a tree and requires
a Tree
or com.smartgwt.client..ResultTree
datatype passed via the data
attribute to
initialize the tree view.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.
For information on DataBinding Trees, see TreeDataBinding
.
TreeGrid
.
TreeGrid
is a subclass of ListGrid
and as a result, for all fields except
the field containing the Tree
itself (specified by
treeField
, all properties settable on
${isc.DocUtils.linkForRef('object:ListGridField')} apply to TreeGridField as well.
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.
RPCTransport
transport
for cross-domain calls to JSON services, such as those provided
by Yahoo.
true
.
Override to do something else
|
|||||||||
PREV NEXT | FRAMES NO FRAMES |