|
|||||||||
PREV NEXT | FRAMES NO FRAMES |
changed
handler specified on the ListGridField will be passed onto the editors for this field.
change
handler
specified on the ListGridField will be passed onto the editors for this field.
FilterClause
to this FilterBuilder.
canCloseTabs
is set, this notification method fired
when the user clicks the "close" icon for a tab.
numRows
attribute.
numRows
attribute.
doubleClickDelay
by default) in this object.
com.smartgwt.client.widgets.DragCompleteHandler
.
com.smartgwt.client.widgets.DragCompleteHandler
.
com.smartgwt.client.widgets.DragCompleteHandler
.
com.smartgwt.client.widgets.DragCompleteHandler
.
com.smartgwt.client.widgets.DragCompleteHandler
.
com.smartgwt.client.widgets.DragCompleteHandler
.
canDrag
is true and canDrag
is true, this notification method will be fired when
the user drags the drawItem
canDrag
is true and canDrag
is true, this notification method will be fired when
the user starts to drag the drawItem
canDrag
is true and canDrag
is true, this notification method will be fired when
the user completes a drag on the drawItem
com.smartgwt.client.widgets.DropCompleteHandler
.
com.smartgwt.client.widgets.DropCompleteHandler
.
com.smartgwt.client.widgets.DropCompleteHandler
.
com.smartgwt.client.widgets.DropCompleteHandler
.
com.smartgwt.client.widgets.DropCompleteHandler
.
com.smartgwt.client.widgets.DropCompleteHandler
.
EditorExitEvent.cancel()
from within EditorExitHandler.onEditorExit(com.smartgwt.client.widgets.grid.events.EditorExitEvent)
from this method to cancel the default behavior (Saving / cancelling the current edit / moving to the next
edit cell)
TreeGrid.closeFolder
.
TreeGrid.openFolder
.
iconClick
method will
be fired instead (if specified).
natively submit
a form
is unable to submit to the server.
com.smartgwt.client..FormulaBuilder
to create a new Formula Field.
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 handleHover()
is hidden.
icon
, a separate click handler
for the icon may be defined as this.iconClick
.
iconField
has been specified.
canFocus
:
true).
canFocus
: true).
Lane
to the calendar in timelineView
mode.
Layout.addMember
.
Layout.addMember
.
mouseStillDownDelay
by
default) when the system is idle - i.e.
Portlet
instance to this portalLayout in the specified position.
Portlet
instance to this portalLayout in the specified position.
Portlet
instance to this portalLayout in the specified position.
canExpandRecords
set to true.
TreeGrid.addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler)
instead.
canExpandRecords
set to true.
NavigationMode
.
canRemoveRecords
is true.
resizer
saveOnEnter
is set and the user presses Enter whilst in a text-item in any clause or subclause.
separator
.
DynamicForm.setValues
or FormItem.setValue
and may be overridden by CanvasItems
intended to support displaying data values to update the embedded Canvas to reflect the value passed in.
sort specifiers
change
for this grid.
sort button
.
sort button
.
com.smartgwt.client..SummaryBuilder
to create a new Summary Field.
showGridSummary
or showGroupSummary
is true,
this method can be used to specify a SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true,
this method can be used to specify a SummaryFunctionType
for calculating the summary value to display.
icon
.
RPCManager.loadScreen(String, LoadScreenCallback, String[])
API.
pickerIcon
is clicked should display RelativeDateItem
s or DateItem
s.
ListGrid.getSelectedCellData
and applies the data at the
current selection.
Criteria
.
Criteria
.
SummaryFunctionType
to a set of records and a field.
type:"icon"
be sized by default?<TEXTAREA>
object) automatically expands to
accomodate its contentautoFitWidth
is true?CubeGrid
indicating which cells in the body should be
selected when row or column headers are selected.Record
which represents an event to occur at a specific time, displayed
within the calendar.ApplicationDeclaration
file.
ApplicationDeclaration
file.
Callback
is an arbitrary action to be fired - usually passed into a method to be fired asynchronously as
a notificaction of some event.callback
can be defined in the following formats: a
function A string containing an expression to evaluate An object with the following properties:this
.Callbacks
are fired via the Class.fireCallback method, which allows named parameters
to be passed into the callback at runtime.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.
DynamicForm.cancelEditing
when clicked.canEditTabTitles
), dismiss the editor and discard the edit value entered by the user.
name
field of this
grid's data tree.
canEditCriterion()
method of the FormItemCanEditCriterionPredicate
that is registered with this field.
CubeGrid
widgets.ListGrid.setSort
with a null parameter.
FormItem.clearValue
if appropriate.
Canvas.showClickMask
to determine the
masks behavior when clicked.closeConfirmationMessage
to the user before removing the portlet from the PortalLayout via PortalLayout.removePortlet
ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
record
which has been previously expanded
using ListGrid.expandRecord
.
Tree
class, which manipulates hierarchical data sets
the TreeGrid widget class, which extends the ListGrid class to visually present tree data in an
expandable/collapsible format.DataSource#compareCriteria
to determine whether new
criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more restrictive, returning
1, 0 or -1 respectively.
DataSource#compareCriteria
to determine whether new
criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more restrictive, returning
1, 0 or -1 respectively.
DataSource.compareCriteria
to
determine whether new criteria is equivalent to the old criteria (returns 0) or not.
DataSource.compareCriteria
to
determine whether new criteria is equivalent to the old criteria (returns 0) or not.
type
"datetime" or "date".
process state
.
process state
.
substring
.ControlNames
are strings used to specify which UI controls should appear in the editor toolbar.record
containing its attributes for properties
named in properties
.
record
to destRecord
for
properties named in properties
.
Record
s (including a TreeNode)
to a new array of Record
s, omitting component-specific metadata such as selected state
from grids, or parent folders for TreeNodes.
showRecordComponents
is true, this method
is called for a row/cell the first time it is brought into the drawArea, or when there are not yet any components in
the pool.
DataSource.combineCriteria
method.SimpleType
."M"
, "D"
and "Y"
characters to indicate the
format of strings being parsed into Date instances via Date.parseInput()
.workdays
, and returns true if found.
useTextField
false.RelativeDateItem
s (if allowRelativeDates
is true) or two DateItems
.datetimes
.Process
by evaluating a series of criteria against
the state
and choosing the element associated with the
criteria that matched, or a defaultElement
if none of the criteria match.defaultValue
when no value is provided for this item.
defaultValue
when no value is provided for this item.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
useTextField
is true, falls through to
standard FormItem.deselectValue
implementation on
this items freeform text entry field.
useTextField
is true, falls through to
standard FormItem.deselectValue
implementation on
this items freeform text entry field.
Canvas.destroy
.
destroy
all DrawItems currently associated with
this DrawPane, leaving the DrawPane itself intact
DetailViewer
.DetailViewer
.Window
used for small windows that contain just
a text
message or a text mesage with some standard buttons.#setDisabled(Boolean),setDisabled(true)
).
ApplicationDeclaration
file.DrawPane
.
DataSource.fetchData
is called).inheritsFrom
.dataProtocol
affects how the data in the DSRequest
(data
)
is sent to the dataURL
.DataSource operation
.automatic cache synchronization
and offline caching and synchronization
).DataSource request
.ListGrid
).
#setDisabled(Boolean),setDisabled(false)
).
hilites
hilites
RelativeDate.START_OF_TODAY
RelativeDate.START_OF_TOMORROW
)
RelativeDate.START_OF_YESTERDAY
)
DrawItem.erase
on all DrawItems currently associated
with the DrawPane.
DataSource.recordsAsText
or DataSource.recordsFromText
.RPCRequest
completes.
RPCManager.sendQueue(RPCQueueCallback)
returns.
record
by creating a subcomponent and inserting
it in to the record's grid-row.
canExpandRecords
is true, ExpansionMode
dictates the type of UI to be displayed in the expanded portion of the row.printable HTML
generated from live UI components
into a .pdf and downloads it ("Save As.." dialog).
printable HTML
generated from live UI components
into a .pdf and downloads it ("Save As.." dialog).
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.recordsAsText
, what approach (if any)
should be used to force values to be intepreted as text instead of heuristically parsed as dates, times or other
structured types.
facet ids
to facetValue ids
within a facet DataSource.fetchData(Criteria,DSCallback,DSRequest)
.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
optionDataSource
).optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
optionDataSource
).pickListCriteria
.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree.
databound
components
understand and treat specially (using type-specific form controls, validators, formatters, sorting logic,
etc).showFilterEditor
) is visible
for this grid, this method will perform a filter based on the current values in the editor.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
DynamicForm.fetchData()
in that a case insensitive substring match will be
performed against the criteria to retrieve the data.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.findIndex(java.util.Map)
, but returns the object itself instead of its index.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.find(java.lang.String, java.lang.String)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findIndex(java.util.Map)
, but inspects a range from startIndex to endIndex.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
RecordList.findNextIndex(int, java.lang.String)
.
fisalCalendar
from the specified defaultDate
and
defaultMonth
If the specified fiscal year date starts
in one calendar year and ends in the next.TileLayout
, but by default lays out tiles in 'flow' mode instead
of 'fit' mode.showFilterEditor
) is visible
for this grid, this method will explicitly put focus into the specified field in the filter editor.
showFilterEditor
) is visible
for this grid, this method will explicitly put focus into the specified field in the filter editor.
DateUtil.setNormalDateDisplayFormat(DateDisplayFormat)
or
DateUtil.setNormalDateDisplayFormatter(DateDisplayFormatter)
.
DateUtil.setNormalDateDisplayFormat(DateDisplayFormat)
or
DateUtil.setNormalDateDisplayFormatter(DateDisplayFormatter)
.
DateUtil.setShortDateDisplayFormat(DateDisplayFormat)
or
DateUtil.setShortDateDisplayFormatter(DateDisplayFormatter)
.
DateUtil.setShortDatetimeDisplayFormat(DateDisplayFormat)
or
DateUtil.setShortDatetimeDisplayFormatter(DateDisplayFormatter)
.
FormItem.formatEditorValue
and FormItem.parseEditorValue
methods.
DrawLabel
.
type
property of the field.DataSource.getDataSource
: Lookup a DataSource by
ID.
DataSource.getDataSource
: Lookup a DataSource by
ID.
baseStyle
for all cells
for this particular record.
edgeStyleName
will be treated as a
base style name and appended with following suffixes to support separate styling per cell:
add event
toolbar button
dataSource
.
AdvancedCriteria
on
fetch or filter type operations.
addUnknownValues
is
false
, this property determines whether the user can clear the comboBoxItem value, or whether they are
constrained to choosing one of the available options (in which case clearing the text box will simply revert to the last
picked value when the user leaves the field).
form.getValuesAsCriteria()
), allows the user to enter simple expressions in any field in this form that takes text
input.
form.getValuesAsCriteria()
), allows the user to type in simple expressions to cause filtering with that operator.
showFilterEditor
:true, allows simple
search expressions to be entered into filter fields, as though allowExpressions
were true.
DataSource
s that have
a primaryKey
, and all primary key values are present in
the request.
RelativeDateItem
s) or whether dates are absolute (via DateItem
s).
true
, the ListGrid.getRowSpan
method will be called for every cell when
rendering out the listGrid to determine how many rows the cell should span.
loading markers
for
rows that are not yet loaded or in the process of loading, respectively.
alternateRecordStyles
is true for this grid.
alternateWeekStyles
.
alt
text for the image HMTL element.
optionDataSource
and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField
is specified and the
new item value is not present in any valueMap explicitly specified on the item.
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
canRemoveRecords
is enabled, should records
be animated out of view when they are removed by the user?
animating record removal
, this property
designates the speed of the animation in pixels per second.
(see
animateRemoveRecord)
, if animateRemoveSpeed
is
not set, this property designates the duration of the animation in ms.
showRollOverCanvas
is true
setting this property to true ensures that when the rollOver canvas is displayed it animates into view via an Canvas.animateShow
.
showRollOverCanvas
is true
setting this property to true ensures that when the rollUnder canvas is displayed it animates into view via an Canvas.animateShow
.
showSelectionCanvas
is true
setting this property to true ensures that when the selection canvas is displayed it animates into view via an Canvas.animateShow
.
showSelectionCanvas
is true
setting this property to true ensures that when the selectionUnder canvas is displayed it animates into view via an
Canvas.animateShow
.
Canvas#animateShow()
is called without an explicit effect parameter.
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?
appImgDir
.
prompt
is specified for this item, should the
prompt be applied to the canvas
for this item?
cacheAllData
:true and a fetch
results in the entire dataset being retrieved, this attribute being set to true causes the DataSource to automatically
switch to cacheAllData:true and prevent further server-trips for fetch requests.
autoPosition
is false, this property controls
whether to automatically center the colorPicker every time it is reshown with the show() method.
field.name
for
any field that does not have a field.title
and is not marked
hidden
:true, by calling the method DataSource.getAutoTitle
.
canvas
be automatically
destroyed when the item is destroyed? Form items are destroyed automatically when a call to DynamicForm.setItems
removes them from their parent form, or if
their parent form is destroyed.
destroyed
, should it also destroy its menu
?
destroyed
, should it also destroy its menu
?
DataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
depending on
DataBoundComponent.getAutoFetchAsFilter()
.
dataSource
, should options be fetched from the server when
the item is first written out, or should this fetch be delayed until the user opens the pickList.
data source
immediately or wait until the
user first opens the pickList.
dataSource
, should options be fetched from the server when
the item is first drawn, or should this fetch be delayed until the user opens the pickList.
optionDataSource
is
specified, a valueMap will be automatically created by making a DataSource.fetchData
call against the specified dataSource and extracting a valueMap from the returned records based on
the displayField and valueField.
optionDataSource
.
autoFetchData
is true
, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData()
call.
loadDataOnDemand
:true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact"
.
headerContextMenu
for this
grid, and canAutoFitFields
is true, this
attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the
ListGrid.autoFitField
method.
autoFitFieldWidths
is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.
autoFitFieldWidths
and
autoFitFieldsFillViewport
are enabled and
auto-fitting will not fill all available horizontal space.
autoFitData
is set to "vertical"
or
"both"
this property specifies the number of additional records for which the grid will expand.
autoFitFieldWidths
is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
headerContextMenu
for this
grid, and canAutoFitFields
is true, this
attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or
content via a call to ListGrid.autoFitField
.
type:"icon"
, fields displaying only value icons
, and boolean fields (which are rendered
as a checkmark type icon by default.
autoFitData
is set to "horizontal"
or
"both"
this property provides the maximum number of columns for which the ListGrid will expand.
autoFitData
is set to "vertical"
or
"both"
this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
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
accommodate its content.
header contextmenu
or via a mouse gesture
, what autofit approach is used.
header contextmenu
or via a mouse gesture
, what autofit approach is used.
dynamicForm.focusInItem(itemName)
Tree.setRoot
is called.
saveByCell
is true).
headerSpans
, setting
this attribute to true will cause spans to expand to accomodate long titles if necessary.
"OK"
-click, and refuse to dismiss if these items contain invalid values.
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?
single-column mode
, this i18n
property dictates the title for the button
docked to
the top left which allows navigation back through the column tree.
showBackgroundComponent
is true
.
showBackgroundComponent
is true
.
fiscal
year column
.
capSize
for the BaseLine
stretchImg.
src
for the BaseLine
StretchImg.
base cell style
for this listGrid.
baseStyle
will be applied to the button.
base cell style
for this listGrid.
baseStyle
To override the baseStyle at the row level, use
record[listGrid.recordBaseStyleProperty]
instead.
fiscal week
column
.
booleanTrueImage
, booleanFalseImage
and booleanPartialImage
.
booleanTrueImage
, booleanFalseImage
and booleanPartialImage
.
browserSpellCheck
IButton
.
ID
.
cacheAllData
or client-only DataSource, a set of
records to use as a dataset, specified as an Array of JavaScript Objects representing records.
dataTransport
:"scriptInclude".
scriptInclude
transport, this attribute
specifies the name of the URL parameter which is used to specify the callback function that
the server is expected to call by writing out JavaScript code.
false
, other records cannot be dropped on (i.e., inserted via drag and drop) immediately before
this record.
treeNode
s) may be dropped over this node.
com.smartgwt.client..FormulaBuilder
.
com.smartgwt.client..SummaryBuilder
.
headerAutoFitEvent
.
warnOnCancel
is true.
this.confirmCancelEditing
is true this property is used as the message
to display in the confirmation dismissal prompt.
targetForm
or targetVM
had cancelEditing()
called on it.
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.
visibilityMode
"mutex", whether to allow
the last remaining expanded section to be collapsed.
groupIcon
) and clicking the icon or double-clicking the group
title will collapse or expand the group.
canDrag
for this to have an effect.
canDrag
.
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 dragability.
Layouts
, except that members are added as items into the
section over which they're dropped.
CalendarEvent
that determines editability.
laneNameField
? If so, the event can be dragged to a
different lane
and, when it's editor is shown, an
additional drop-down widget is provided allowing the user to select a different lane.
titleEditEvent
fires.
canEditTabTitles
setting,
for this one tab only.
canExpandRecords
is true, this property
indicates whether multiple records can be expanded simultaneously.
StaticTextItem
will cause the item to be included in the page's tab order and
respond to keyboard events.
dataSource
, and useAllDataSourceFields
is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item
.
removeIcon
, which, when clicked, will call ListGrid.removeRecordClick
which removes the row from the
data set (or if deferRemoval
is true changes the
ListGrid.markRecordRemoved
status for the record).
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.
Portlets
be drag-resizable?
canResizePortlets
instead.
selectionAppearance
set to "checkbox"
cell-level rollover
.
Portlets
.
SectionItems
will be
included in the page's tab order for accessibility.
CanvasItem
, this property will be
set to point at the item.
autoDismiss
from this menu.
align
.
FacetValueMap
indicating the facet values for the cell.
row spanning
, returns the number of cells
spanned by the cell at the given coordinates.
canSelectCells
is active, returns the CellSelection
object that tracks and manages the current selection.
DynamicForm.getCellPadding()
instead
row spanning
, returns the row number where a
row-spanning cell starts.
cellStyle
DynamicForm.rememberValues
last ran.
rememberValues
last ran.
change
handler
(and store its value in the form) on every keypress? Set to false
to suppress the 'change' handler firing
(and the value stored) on every keypress.
change
handler
(and store its value in the form) on every keypress? Set to false
to suppress the 'change' handler firing
(and the value stored) on every keypress.
FormItem.setValue
.
CubeGrid.makeChart
is called with a chart specification
that will show more than chartConfirmThreshold
data elements, the user will be presented with a confirmation dialog
.
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, and
Radar charts are supported.
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, and
Radar charts are supported.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for an unselected row.
checkbox field
leave around the checkbox icon when selectionAppearance
is set to "checkbox"
?
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 partially selected
row.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for a selected row.
expansionModes
that show another grid or tree, what the child's
expansionMode should be.
multiple:"true"
, controls the name of
the XML tag used for each subelement during DataSource.xmlSerialize
.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
headerContextMenu
for this
grid, and a filter-editor
is visible, this
attribute will be shown as the menu item title to clear any existing filter.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
DSRequests
are executed on it.
clientOnly
or cacheAllData
DataSource.
showCloseConfirmationMessage
is true.
folderIcon
for
closed folders.
folderIcon
for
closed folders.
closeIcon
for this tab.
canCloseTabs
is true.
canCloseTabs
is true.
code
attribute is relative
baseStyle
for the buttons in this grid's column headers.
ids
for facets that will appear on top of the body.
FacetValueMap
indicating the facet values for a specific
column in the grid.
overflow
setting for each column.
column
in this columnTree.
ComboBoxItem
in a MultiComboBoxItem.
ComboBoxItem
.
Tab
key.
DataBoundComponent
, the ID
of the submitting component.
headerContextMenu
for this
grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog
to configure the sort-specification for this grid.
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.
inline view
property.
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 STATUS_LOGIN_INCORRECT
rather than a call
to 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
.
treeField
set to true
to show the tree.
TileGrid
that created this SimpleTile.
AdvancedCriteria
to be applied to the task inputs.
operator
, the name of the DataSource
field for the Criterion
this FormItem generates.
ID
to Criteria that will cause this
ProcessElement to be chosen as the next element if the criteria matches.
ResultSet
cache should be dropped when the criteria
changes.
Criteria
changes.
getCriterion()
method
of the FormItemCriterionGetter
that is registered with this field.
getCriterion()
method
of the FormItemCriterionGetter
that is registered with this field.
ListGrid.getExpansionComponent
currently visible in some record, or null if the specified record is not showing an
expansion component.
ListGrid.getExpansionComponent
currently visible in some record, or null if the specified record is not showing an
expansion component.
default node.showDropIcon
property.
default node.showOpenIcon
property.
default node.showOpenIcon
property.
default
node.icon
property.
serverType
"sql" or "hibernate",
indicates that this field should be omitted by default from all SQL or Hibernate operations, and will only be used with
custom queries
.
Tree
object consisting of nested TreeNode
s to display in this ColumnTree.
Tree
object containing of nested TreeNode
s to display as rows in this TreeGrid.
RecordList
.
RecordList
.
dataColors
Array
dataColors
Array
DataBoundComponent
needs to show a short summary of a record.
RecordLayout
s.
DataSource.fetchData
is called).
showDataPoints
).
showDataPoints
).
DataSource
is this resultSet associated with?
DataSource requests
.
DSRequest
.
DSRequest
.
DSRequest
.
data
/menu.items.
DataSource
is this resultTree associated with?
specified month
when this fiscal
year starts.
DateDisplayFormat
for Date type values displayed in this form.
useTextField
is true
this
property can be used to customize the format in which dates are displayed for this item.DateDisplayFormat
.
date picker
toolbar button
DateDisplayFormat
for Date type values displayed in this form in fields of
type datetime
.
TimeUnit
is "day".
daySelector
.
TimeUnit
is "day".
decimalPrecision
used to render the numeric
labels of this metric axis.
specified
month
to use for calculating fiscal dates when no fiscal years
are provided.
sectorIndex
.
field.groupingMode
is unset.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to
the height of the header when minimized.
fiscal years
are provided.
titleProperty
value or
a nameProperty
value.
quantityField
.
RequestTransformer.getDefaultTransformRequest(DSRequest)
instead
canRemoveRecords
causes records to be marked for future removal via ListGrid.markRecordRemoved
instead of immediately being removed.
CalendarEvent
The name of this
field within the CalendarEvent can be changed via descriptionField
CalendarEvent
.
RecordLayout
s except
"titleOnly".
true
, the destroy()
method
has been called on this canvas.
destroyed
.
Canvas.destroy
method is called
on a widget.
destroying
.
destroy()
when closing the Portlet.
destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab
}.
DataBoundComponent
.
canExpandRecords
is true and listGrid.expansionMode
is "related"
, this property specifies the
dataSource for the related records grid to be shown embedded in expanded records.
recordDetailDSProperty
.
canExpandRecords
is true
and listGrid.expansionMode
is detailField
.
detailToolStrip
.
DetailViewer
that is automatically created to render the
contents of tiles by default.
disabled
.
disabled
.
canEdit
is set to false, should icons
be disabled by default?
canEdit
is set to false, should icons
be disabled by default?
canEdit
is set to false, should this icon be
disabled.
request queuing
for this RestDataSource.
confirmDiscardEdits
is true this is the
title for the save button appearing in the lost edits confirmation dialog.
parentIdField
which doesn't map to a valid parent node be
dropped? If set to false, for loadDataOnDemand
:false trees, parentless nodes will be added as children of the root node - for loadDataOnDemand
:true, they will be added as children of
the folder currently requesting children.
modelType:"parent"
, should nodes in the data
array for the tree be dropped if they have an explicitly specified value for the parentIdField
which doesn't match any other nodes in the tree.
displayField
of the combo box.
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.optionDataSource
field used to
retrieve the display values that are to be mapped from the internal values specified by valueField
.
displayField
is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name
of the field.
displayField
for this item.
displayField
for this item.
displayField
for this form
item.
displayField
for this item.
DateDisplayFormat
or a function which will return a formatted date time string.
valueMap
for
the field and return the display value for the field.
com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap
or com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField
,
this method will return the display value for any underlying data value.
com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap
or com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField
,
this method will return the display value for any underlying data value.
com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap
or com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField
,
this method will return the display value for any underlying data value.
com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap
or com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField
,
this method will return the display value for any underlying data value.
com.smargwt.client.widgets.grid.ListGridField#setValueMap(),valueMap
or com.smartgwt.client.widgets.grid.ListGridField#setDisplayField(),displayField
,
this method will return the display value for any underlying data value.
displayField
is set, should this field show
record values from the displayField
?
showDoughnut
),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.
a new browser
window
.
downloadResult
is true, setting this attribute to true
causes the content of the downloaded file to be displayed in a new browser window.
"target"
, this value specifies the opacity to render the target while it
is being dragged.
canDragReposition
is true, this attributes specifies
the visual appearance to show during drag reposition.
canDragResize
is true, this attributes specifies the
visual appearance to show during drag resize.
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.
DrawGroup
this drawItem is a member of.
DrawPane
this drawItem should draw in.
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
.
dropTypes
is set to ["PortalColumn"]
in order to allow the dragging of columns within the
PortalLayout
.
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
Smart GWT will apply to the dropped object before updating it.
preventDuplicates
is enabled.
setCriterionGetter()
whereby if this item
contains a DynamicForm as its canvas, it will be used to edit nested AdvancedCriteria automatically.
ListGrid#getEditedRecord()
, this method returns a copy of the
record being edited, with unsaved edit values applied.
ListGridEditEvent
for options.
this.editFailedCSSText
this.editFailedBaseStyle
instead.
editable
ListGrid.
editable
ListGrid.
iconHeight
.iconHeight
instead.
iconWidth
.iconWidth
instead.
imageURLPrefix
to the editor in question.
imageURLSuffix
to the editor in question.
this.editPendingBaseStyle
instead.
ProcessElement
by it's ID
ProcessElement
s in this sequence.
emptyMessage
if
displayed.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
CalendarEvent
The name of
this field within the CalendarEvent can be changed via endDateField
CalendarEvent
.
fixedRecordHeights
is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers.
FormItem.getValue
in various cases - for example:
for items that constrain the value range, such as a DateItem
with
enforceDate
:true, or a ComboBoxItem
with addUnknownValues
:false for items with
a defined valueMap or edit value formatter and parser functions which converts display value to data value
while the item has focus if changeOnKeypress
is false
useTextField
is true (otherwise returns the result of
this.getValue()).
FormItem.getValue
in various cases - for example:
for items that constrain the value range, such as a DateItem
with
enforceDate
:true, or a ComboBoxItem
with addUnknownValues
:false for items with
a defined valueMap or edit value formatter and parser functions which converts display value to data value
while the item has focus if changeOnKeypress
is false
FormItem.getValue
in various cases - for example:
for items that constrain the value range, such as a DateItem
with
enforceDate
:true, or a ComboBoxItem
with addUnknownValues
:false for items with
a defined valueMap or edit value formatter and parser functions which converts display value to data value
while the item has focus if changeOnKeypress
is false
enterKeyEditAction
as
specified at the listGrid level while focus is in this field.
type "enum"
in the DataSource, by default a newly edited row
will use those filter criteria as initial values.
EnumUtil.getEnums(ValueEnum[], String[], ValueEnum[])
method
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 accommodate the error message and icon.
{fieldName:errors}
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.escapeKeyEditAction
as
specified at the listGrid level while focus is in this field.
EscapingMode
expected for escaping special characters embedded in text values.
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
.
eventWindowStyle
for an individual CalendarEvent
.
LayoutPolicy
:"fit", should margins be expanded so that tiles fill the available
space in the TileLayout on the breadth axis? This can also affect tileWidth
or tileHeight
.
expansionModes
that show another grid or tree, is that component
editable?
ExpansionMode
is editor, should the row be collapsed following a save
initiated by the expansion-component's save button
.
expansionEditorSaveButton
.
canExpandRecords
is true and expansionMode
is editor, the prompt to display in a
dialog when an expanded row is collapsed while it's nested editor has changed values.
canExpandRecords
is true and expansionMode
is editor, whether a dialog should be
displayed when an expanded row is collapsed while it's nested editor has changed values.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for collapsed rows.
canExpandRecords
is set to true
,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for expanded rows.
ExpansionMode
for records in this grid.
DataBoundComponent.exportClientData
.
XLS
and OOXML
.
exportToFilesystem
is set, optionally specifies a
path to use when saving the file.
exportClientData()
.
exportClientData()
.
exportFilename
and
exportAs
respectively.
exportFilename
and
exportAs
respectively.
ListGrid
that has headerSpans
, should headerSpans also be exported.
ListGrid
that has headerSpans
defined and exportShowHeaderSpanTitles
is true, the behavior is
dependent on the export type.
exportDisplay
.
DataBoundComponent.exportClientData
.
extra axis metric
is plotted.
TreeGrid.getExtraIcon
) or checkbox icon and the nodeIcon
/
folderIcon
or node text.
CubeGrid
, and it has a facetId
property specified then the Cube treats this as adding that facetId at the drop location.
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels.
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels.
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues.
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues.
type
.
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.
optionDataSource
and this property is true
, the list of fields
used by this pickList will be passed to the datasource as outputs
.
optionDataSource
and this property is true
, the list of fields
used by this pickList will be passed to the datasource as outputs
.
optionDataSource
, should the item ever perform a fetch against this dataSource to retrieve the related record.
dataSource
.
Record
that this criterion applies to.
fieldPicker
autoChild FormItem.
field-picker
select-item.
field-picker
select-item.
headerContextMenu
for this
grid, and this.canPickFields
is true, this attribute
will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide
fields in the grid.
filterBuilder
containing this clause, or null if this
filterClause is not embedded in a filterBuilder.
showFilterEditor
is true, this method will
return the criteria currently displayed in the filterEditor
.
showFilterEditor
is true, this method will
return the criteria currently displayed in the filterEditor
.
filterEditor
if showFilterEditor
is true.
data property
set to a static array of
records, should ListGrid.filterData
filter this array? If
this property is set to true, the local data array will be filtered according to the specified criteria, and the results
displayed.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
optionDataSource
, displayField
and fetchMissingValues
), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch
the entire set of options from the server, and use these values to map the item value to the appropriate display
value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
FilterEditor
showing, the Operator to
use when matching values for this field.
ComboBoxItem.getPickListFilterCriteria
.
showHeaders
is set
(the remaining columns have their titles derived from the item selected in the column to the left).
com.cmartget.client.widgets.FiscalCalendar
.
FiscalCalendar
object that will be used by this DateChooser.
FiscalCalendar
object that will be used by this DateChooser.
FiscalYear objects
which each represent the start date of a
single fiscal year.
single-facet
chart of an extra value axis,
this property provides a constant facet value for the second facet.
FacetValueMap
describing the set of facet values that should be regarded as
"fixed" in this cubeGrid.
ForceTextApproach
unless they have a
specific setting for DataSourceField.exportForceText
.
GwtEvent.getSource()
to determine the source of this event (could be a DynamicForm
or ValuesManager
formatEditorValue
re-run whenever
this item recieves or loses focus? Setting this property allows developers to conditionally format the display value
based on item.hasFocus, typically to display a longer, more informative string while the item does not have focus, and
simplifying it down to an easier-to-edit string when the user puts focus into the item.
natively
submit
a form is unable to submit to the server.
headerSpans
, and showHeaderSpanTitlesInFormulaBuilder
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in
the FormulaBuilder and SummaryBuilder.
canAddFormulaFields
.
formula
String to the fieldNames these variables should represent in
the context where the formula is evaluated.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
fromDate
is supplied.
from
part of the range.
extra value axes
.
showGridSummary
is true
this
method is called for each field which will show a grid summary value (as described in showGridSummary
to get the summary value to display
below the relevant column.
summaryRow
when showGridSummary
is true.
showGridSummary
is true, this attribute will be
set to true on the record object representing the grid summary row.
gripImgSuffix
to simplify providing custom
grip media for this widget.
showGrip
is true.
showGrip
is true.
ComponentSchema
, indicates what group to place the property in when editing
in Visual Builder.
grouped
, and showGroupSummary
is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear.
headerContextMenu
for this
grid and this.canGroupBy
is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field.
grouping modes
,
the current grouping mode.
ListGrid.setGroupState
to reset this grid's grouping to the
current state (assuming the same data / fields are present in the grid).showGroupSummary
is true, this attribute will
be set to true on each record object representing a group-level summary row.
customStyle
for the group-level summary row
displayed when showGroupSummary
is true.
GroupTitleRenderer.getGroupTitle(Object, GroupNode, ListGridField, String, ListGrid)
ToolStripGroups
.
groupTitleColumn
.
grouped
, each group shows under an auto
generated header node.
ToolStripGroups
.
GroupValueFunction.getGroupValue(Object, ListGridRecord, ListGridField, String, ListGrid)
baseStyle
to apply to the buttons in the header, and the sorter,
for this ListGrid.
headerBaseStyle
.headerTitleStyle
as well.
headers
shown above the event area,
and their time units.
showHeaderMenuButton
is true, this property
governs the height of the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the auto-generated headerMenuButton
headerSpan
with no height
specified.
showHeaderBackground
is true
, this
property provides the URL of the background image for the header.
titleStyle
to apply to the buttons in the header, and
the sorter, for this ListGrid.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass thereof.
group rectangle
in pixels relative to
the DrawPane.
rowHeight
(if no rowHeight is set).
type
: "separator"
, this attribute
specifies the height of the separator.
rowHeight
(if no rowHeight is set).
hideEmptyFacetValues
, controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the 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.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
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.headerSpans
, and showHeaderSpanTitlesInHiliteEditor
is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid.
showHeaderBackground
is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashed
hilite
icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconLeftPadding
hilite icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconLeftPadding
hiliteIcons
are present, where the hilite icon
will be placed relative to the field value.
hiliteIcons
are present, where the hilite icon
will be placed relative to the field value.
hiliteIcons
are present, where the hilite
icon will be placed relative to the field value.
hiliteIcons
are present, where the hilite
icon will be placed relative to the field value.
hilite
icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconRightPadding
hilite icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconRightPadding
hilites
.
hilites
.
hilite icons
for this
component.
hilite icons
in this field.
hilite icons
for this
component.
hilite icons
in this
field.
TimeUnit
is "hour".
TimeUnit
is "hour".
this.showHover
is true, this property can be used to customize the alignment of content in the hover
canvas.
this.showHover
is true and Canvas.getHoverComponent
is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden?
showHoverComponents
is true, this method is
called to get the component to show as a hover for this 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, when the user holds the mouse over this Canvas for long enough to trigger a
hover event, a hover canvas is shown by default.
showValueOnHover
is enabled.
showHoverComponents
is true, the builtin
mode to use when automatically creating a hover component for rows in this grid.
this.showHover
is true, should this widget's hover canvas be moved with the mouse while visible?
this.showHover
is true, should the hover canvas be shown with opacity other than 100?
this.showHover
is true, this property can be used to specify the css style to apply to the hover canvas.
this.showHover
is true, this property can be used to customize the vertical alignment of content in the
hover canvas.
this.showHover
is true, this property can be used to
customize the width of the hover canvas shown.
this.showHover
is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps.
vertical
is false, and src
is unset.
vertical
is false and src
is unset.
vertical
is false and src
is unset.
htmlElement
is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement
in the DOM.
xmlHttpRequest
transport) contains the HTTP response code sent
by the server.
message
.
name
return a pointer to the icon
definition
name
of the icon.
Orientation
.
type
:"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.
icon
is specified, this property may be used to specify a size
for the icon
"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.
icon
is specified, this property may be used to specify a size
for the icon.
iconVAlign
.
icon
is specified, this property can be used to
specify the width of the icon to be displayed in the ListGrid header button.
icon
is specified, this property may be used to specify a size
for the icon
Gateway
s, or as the startElement
.
TreeNode
that holds an id for the node which is
unique across the entire Tree.
generateClickOnSpace
, generateClickOnEnter
,
generateDoubleClickOnSpace
, generateDoubleClickOnEnter
and arrowKeyAction
).
items
for this stretchImg display left-to-right even
if this page is displaying right to left text
?
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
valueIcons
when determining the URL for the image.
ListGridFieldType
] set to "image"
and the URL for
the image displayed is not absolute, the path of the URL will be relative to this stringvalueIcons
when determining the URL for the image.
"image"
and the URL for the image displayed is not absolute, the path of the
URL will be relative to this stringvalueIcons
when
determining the URL for the image.
valueIcons
) or this is has ListGridFieldType
set to "image"
, this the value of this property will be
appended to the end of the URL for the icon displayed.".gif"
to the filename of the image.imageURLSuffix
.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
delay
, as well as when the entire form is submitted.
delay
, as well as when the entire form is submitted.
implicitSave
is true, this attribute dictates
the millisecond delay after which form items are automatically saved during editing.
ComponentSchema
, a field inherited
from another schema can be redeclared with this property
set in order to indicate that the property should not be used.
omitControls
.
summary row
for this grid.
grid summary
.
treeField
column, should the component be indented to the position where a title would normally show?
DataBoundComponent
needs to show a short summary of a record.
RecordLayout
s.
fields
from.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
baseStyle
for the buttons in the innermost column header for
this cubeGrid.
TileGrid.getTileHTML
.
inputField
.
process state
which is provided as input data to
this task.
process state
which are
provided as input data to this task.
useTextField
is true
this
property can be used to specify the input format for date strings.
"date"
, if this is an editable field such as a TextItem
, this property allows you to specify the inputFormat
applied to the item.
useTextField
is true
this
property can be used to specify the input format for date strings.
"date"
, if this is an editable field such as a TextItem
, this property allows you to specify the inputFormat
applied to the item.
inputFieldList
, as a Record.
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.
showGridSummary
, showGroupSummary
or listGridFieldType:"summary"
), and the summary function returns
"null"
(implying it was unable to calculate a valid summary value).
showGridSummary
is true.
showGroupSummary
is true.
canRemoveRecords
is true, this
field will be rendered as the remove-field for this grid.
true
, defines a horizontal separator in the
listGrid object.
true
, this menu item shows a horizontal separator instead of the title
text.
record[this.isSeparatorProperty]
is set for some record, the record will be displayed as a simple
separator row.
FormItem
from this ValuesManager.
recordXPath
mapping to the data node of json returned by the server.
"A"
, "Enter"
)
"A"
, "Enter"
)
"A"
, "Enter"
)
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout overview
).
lane
this CalendarEvent
should sit in.
lane
in
which this event will be displayed for the timelineView
Orientation
is "vertical".
selectionAppearance
:"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent?
position
property).
group rectangle
in pixels
relative to the DrawPane.
position
property).
Icon
for the leftButton
Title
for the leftButton
ListGridFieldType
] set to "link"
, setting this
property will apply a standard prefix to the link URL for cells in this field.
"link"
, setting this property will apply a standard prefix to the link URL
when displaying values of this field.
ListGridFieldType
] set to "link"
, setting this
property will apply a standard suffix to the link URL for cells in this field.
"link"
, setting this property will apply a standard suffix to the link URL
when displaying values of this field.
contentsURL
property has been set.
loadingMessage
.
LocatorTypeStrategy
to use when finding children within this canvas.
"title"
use the title as an identifier within this
form "value"
use the value of the item to identify it (often used for items with a static
defaultValue such as HeaderItems "index"
use the index within the form's items array.
LocatorTypeStrategy
to use when finding members within this layout.
LocatorTypeStrategy
to use when finding peers of this canvas.
LocatorTypeStrategy
to use when finding Sections within this section Stack.
ID
this will always be used.
useLogGradations
, base value for
logarithmic gradation lines.
useLogGradations
, base value for
logarithmic gradation lines.
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 0 and logBase
.
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase
.
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
.
topOperatorAppearance
:"radio".
topOperatorAppearance
:"radio".
htmlElement
is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?topOperatorAppearance
:"radio".
canExpandRecords
and canExpandMultipleRecords
are both true, this
property dictates the number of records which can be expanded simultaneously.
\${...}
will be evaluated as JS code when the message is displayed.
managePercentBreadth
:true.
MenuButton
generated for it automatically (for example
when included in a MenuBar
, the width that the MenuButton should have.
menu
when clicked.
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.
TimeUnit
is "millisecond".
TimeUnit
is "millisecond".
canvas.animationTime
.
TimeUnit
is "minute".
TimeUnit
is "minute".
TimeUnit
is "month".
monthSelector
.
TimeUnit
is "month".
showMoreTab
is enabled
and the number of tabs to show exceeds moreTabCount
.
showMoreTab
is enabled this property determines the
image to display on the "More" tab button.
"move"
control
knob
, this attribute
specifies where the knob should appear with respect to the drawItem.
multiple
set to 'true' be
displayed?
field.type
.
CalendarEvent
The name of this field
within the CalendarEvent can be changed via nameField
laneNameField
property on the CalendarEvent.
ListGrid.setHeaderSpanTitle
.
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.
showNavigation
is true and NavigationMode
is set to "navIconOny".
navigationBar
managed by this widget.
DrawnValue
object.
DrawnValue
object.
icon.neverDisable
is true, when this form item is disabled, the icon will remain enabled.
ResultSet.setCriteria(com.smartgwt.client.data.Criteria)
are applied to it, and it may disappear from the cache.
next
toolbar button
sequence
or element
to execute after this one completes.
sequence
or {process.elements,element} to
procede to if no error condition arises.
sequence
or {process.elements,element} to
procede to if the criteria match the process state.
Page.isRTL
is true.
Page.isRTL
is true.
xsi:nil
being used to transmit the value when serializing
to XML, like so:
baseStyle
is unset, base style will be derived from
normalBaseStyle
if this grid has fixed row heights
and the specified cellHeight
matches this value.
offlineMessage
if
displayed.
offline storage
.
update
or remove
operation, the original values from the record that is being updated
or removed.
DynamicForm.rememberValues
.
ValuesManager.rememberValues
.
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
to determine if the node is open or not.
TreeGrid.setOpenState
to open the same set of
folders within the treeGrid's data (assuming the nodes are still present in the data).
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.
RelativeDateItem.getCriterion
the
FormItemCriterionGetter
's getCriterion()
method is called.
optionDataSource
, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
optionDataSource
is set for this
ListGridField, criteria specified in this attribute will be passed to the dataSource when performing the fetch operation
to determine data-value to display-value mappings
optionDataSource
of the combo box.
optionDataSource
and extracting the valueField
and displayField
in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource.
optionDataSource
, and this property is
not null, this will be passed to the datasource as RPCRequest
properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
autoFetchDisplayMap
is set, this attribute
provides a way to customize the dataSource request issued to fetch the display map from
the option dataSource.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
autoFetchDisplayMap
is set, this attribute
provides a way to customize the operationId
passed to
dataSource.fetchData()
when retrieving the display map from the option dataSource.
optionDataSource
, where
autoFetchDisplayMap
is true, this property
will govern the textMatchStyle
attribute of the DSRequest
parameter passed
to DataSource.fetchData
when retrieving the remote data set to be
used as a basis for this field's valueMap.
RecordList
.
ResultSet
.
baseStyle
for a cell
that is currently a selection origin for shifted incremental cell selection.
showOtherDays
is false.
Other...
item.
Other...
item.
process state
which this task writes outputs to.
process state
which this
task will write to.
"foo, bar, baz"
).
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 accommodate members.
Portlet
widths
overflow the width of the PortalLayout.
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
accommodate 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
accommodate members.
this.padding
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
this.padding
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
facet.isTree
), id of this facetValue's parent
facetValue.
load data on demand
with web services, parentNode
is automatically set in "fetch" DSRequests issued by a databound TreeGrid that is loading
children for that parentNode
.
partialCommit
is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors.
partialCommit
is set to "prompt", the text to
display to the user in the confirmation dialog.
"summary"
.
([name][pathDelim]?)*
snapTo
.
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
].
showTabPicker
is true, this property governs the size
of tab-picker button.
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
].
dateChooser
autoChild
displayed to allow the user to directly select dates.
DateChooser
for choosing an absolute date.
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, this attribute
specifies the name
applied to the picker icon
pickerIcon
.
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.
record components
, be pooled
per column or per record.
Portlets
in this PortalLayout,
where the first level corresponds to columns, the second to rows, and the third to Portlets within rows.
Portlets
in this PortalLayout.
prettyPrint
feature to enable indented, highly readable JSON
messages.
Portlet
in a column will be stretched to fill the
column's height, or left at its specified height.
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.
preventHTTPCaching
on a per-operationType
basis.
Portlet
in a row will be stretched to fill the
row's width, or left at its specified width.
previous
toolbar button
sequence
or element
that is helpful for wizards.
Page.isRTL
is true.
Page.isRTL
is true.
primaryKey
fields.
primaryKey
fields as a map of
fieldName to field.
printCellStyle
printable HTML
.
ResultSet
documentation
.
progressive loading mode
for this specific
request, overriding the OperationBinding- and DataSource-level settings.
progressively
.
progressively
.
prompt
for the header).
showHover
is true.
prompt
for the header).
showHover
is true.
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).
radioOperatorForm
.
recordComponent
currently being
shown at the given coordinates.
recordComponent
currently being
shown at the given coordinates.
showRecordComponents
is true, this
attribute may be used to specify a standard height for record components.
component-pooling
to employ for recordComponents
.
showRecordComponents
is true, how should
the component appear within the cell.
listGrid.expansionMode
is "related".
RecordList
.
type:"summary"
),
this attribute specifies a custom base style to apply to cells in the summary field
"summary"
.
recordXPath
.
xmlRecordXPath
or jsonRecordXPath
is used based on
the dataFormat
setting.
DataSource
containing data related to the passed record.
marked for removal
.
ListGridField
attributes of remove fields.
canRemoveRecords
is enabled.
remove field
.
canRemoveRecords
is enabled, default icon to
show in the auto-generated field that allows removing records.
remove icons
for this
ListGrid.
id field value
as existing nodes, the existing nodes are removed when
the new nodes are added.
DSRequest
s made by this DataSource.
DSRequest
created for this operation.
DataSourceField
,
enabling both client and server side validation.
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.
canDragResize
, restricts
resizes to only certain edges or corners.
"resize"
control
knobs
, this attribute
specifies which sides / edges should show knobs.
ResultSet
.
RTL mode
, should cell alignments specified cellAlign
be reversed (so an align:"right"
field will have content aligned on the left and vice versa)?
Icon
for the rightButton
Title
for the rightButton
showRollOverCanvas
is true, this
method will be called to create the canvas to display over the current row when a
user moves their mouse over the row.showMenuOnRollOver
is true, this is the
delay in milliseconds before the menu is automatically hidden following mouseOut.
showRollUnderCanvas
is true, this
method will be called to create the canvas to display under the current row when a
user moves their mouse under the row.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.
ids
for facets that will appear to the left of the
body.
FacetValueMap
indicating the facet values for a specific
row in the grid.
baseStyle
for the buttons in this grid's row headers.
com.smartgwt.client.grid.GridRenderer
component.
PortalLayout
,
then the height will be used when creating the new row.
PortalLayout
,
then the height will be used when creating the new row.
rowNumberField
.
RibbonBar
, the number of rows this button should consume.
useRowSpanStyling
is enabled.
dataSource
, this property can
be set to true
to prevent the grid from attempting to save / retrieve data from the server.
true
, when the user hits the Enter key while focused in a text-item in this form, we automatically
submit the form to the server using the DynamicForm.submit
method.
saveOnEnter
is true.
saveOnEnter
is true on the parent form.
saveOnEnter
is true.
saveOnEnter
is true.
FilterBuilder.search
method.
DSOperationType
to be performed when DynamicForm.saveData
is called.
DSOperationType
to be performed when DynamicForm.saveData
is called.
DSOperationType
to be performed when DynamicForm.saveData
is called.
dataSource
, where
saveLocally
is false, this attribute may be used to
specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user
interaction, or explicit saveEdits or saveAllEdits call).
DynamicForm.submit
actions when called (typically from a SubmitItem
).
showTabScroller
is true, this property governs the
size of scroller buttons.
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition
set to "top" or "bottom"].
tab scroller buttons
, and
symmetricScroller
is false, this property governs
the base URL for the tab bar back and forward scroller button images.
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition
set to "left" or "right"].
workday hours
to be sized to
fill the available space in the day view and week view, and automatically scrolls these views to the start of the
workday when the calendar is first displayed and whenever the user switches to a new day or week.
TimeUnit
is "second".
TimeUnit
is "second".
SectionStack
in which this section header is embedded.
SectionStack
in which this section header is embedded.
SectionItem
s], this attribute
controls whether multiple sections can be expanded at once.
Gauge.getDefaultFillColor
to initialize the fill color of
new sectors.
sectorIndex
.
sectorIndex
.
sectorIndex
.
TreeGrid.setSelectedPaths
to reset this
grid's selection the current state (assuming the same data is present in the grid).optionDataSource
when fetchMissingValues
is true, and the missing value is fetched.
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.
selectionType
is "single"
, or if you only care about the first selected record in a multiple-record selection.
SelectItem.setOptionDataSource(com.smartgwt.client.data.DataSource)
optionDataSource} and allowing multiple
selection multiple
:true, returns the list of currently selected records, or null if none are selected.
ListGrid.setSelectedState
to reset this
grid's selection the current state (assuming the same data is present in the grid).multi-sort
grid) in the selected state.
ListGrid.getSelectedRecords()
instead
ListGrid.getSelectedRecords(boolean)
instead
useTextField
is true, falls through to
standard com.smartgwt.client.widgets.form.fields.FormItem#getSelectionRange
implementation on this items
freeform text entry field.
TextItem
, TextAreaItem
) is
given focus programmatically (see DynamicForm.focusInItem
), 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.
separateFolders
on the data for this treeGrid.
members
.
Other...
item in the drop down list.
Other...
value.
serverType:"sql"
with a field of
type "sequence", the name of the SQL sequence that should be used when inserting new records into this table.
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.
callback
as data
.
form.getValues()
?
DynamicForm.getValuesAsCriteria
is called, for the
criterion to be included in the returned AdvancedCriteria object
form.getValues()
?
DynamicForm.getValuesAsCriteria
is called, for the
criterion to be included in the returned AdvancedCriteria object
separator rows
in between.
separatorRows
in between.
separatorRows
in between.
true
this grid will create and show per-row backgroundComponents as detailed here
.
pickerIcon
.
showChooserFiscalYearPicker
.
Window.closeClick
.
closeConfirmationMessage
will be
displayed before portlets are closed
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
showGrip
is true, this property determines whether the grip
image displayed should show the "Closed"
state when the target
is hidden.
component.fields
.
DynamicForm
will set both showComplexFields
and
showComplexFieldsRecursively
on any nested component used for showing/editing a complex field.
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder.
customIconProperty
), show open state images when the
folder is opened.
customIconProperty
), show open state images when the
folder is opened.
dateChooser
is displayed.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
detail:true
when a DataBoundComponent is
given a DataSource but no component.fields
.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
detail:true
from this component's DataSource
.
detail:true
in the DataSource.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
selectionAppearance
:"checkbox" is set on the treegrid, and a node can't be selected?
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.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
"target"
, should we show a shadow behind the canvas
during the drag.
icon
), this
property allows the developer to specify on a per-node basis whether a drop state icon should be displayed when the
user drop-hovers over this folder.node.showDropIcon
to true to show the drop state icon, or false
to suppress this.showCustomIconDrop
for this node.
EdgedCanvas
should be used to show image-based edges around this
component.
emptyMessage
when there is no data to
display?
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
ExpansionMode
is editor, should a Save button be shown below the the
expanded editor?
canFilter:false
fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocused
is true for this widget, should the
"over"
state be used to indicate the widget as focused.
showFocused
property.
showPickerIcon
is true for this item,
should the picker icon show a focused image when the form item has focus?
showFocused
, showFocusedIcons
), this property governs whether
the focused state should be shown when the item as a whole receives focus or just if the icon receives focus.
showConnectors
is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree.
timeUnitOption
we will show only past
options [for example "N weeks ago"].
showGridSummary
is true, should this field show
a summary value.
grouping
, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields.
showGroupSummary
is true, should this field
show a summary value in a summary row when the grid is grouped? If unset, this field will show a summary value in the
summary row if an explicit summaryFunction
is
specified or if a default summary function
is
defined for the specified field type.
grouped
, and showGroupSummary
is true, setting this property causes
field summary values for each group to be displayed directly in the group header node, rather than showing up at the
bottom of each expanded group.
ToolStripGroups
in
this ToolStrip show their header control.
grouped
and showGroupSummaryInHeader
is true, instead of
group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will
show up in the appropriate columns of the header node.
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.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor
.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.
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?
iconField
.
icons
for
this item.
fields
from another DataSource
(via inheritsFrom
), indicates that only the fields listed in
this DataSource should be shown.
menu-icon
which fires the menuIconClicked
notification method when clicked.
menu
when clicked.
moreTabCount
be shown on a "more"
tab?
moreTabCount
be shown on a "more"
tab?
showHeaders
is also set, each column's
header will show a count of the number of nodes in that column
icon
), this
property allows the developer to specify on a per-node basis whether an open state icon should be displayed when the
folder is open.
open
folders than closed folders.
open
folders than closed folders.
valueMap
, by default we show the valueMap
options in the pickList for the item.
valueMap
by default we show the
valueMap options in the pickList for the item.
valueMap
, by default we show the valueMap
options in the pickList for the item.
Over
state?
overCanvas
on user rollover.
showOver
property.
edges
.
edges
, setting
this attribute to true
will set the paneContainer to show customEdges
for the three sides opposing the tabBarPosition.
timeUnitOption
we will show only future
options [for example "N weeks from now"].
icon
for this form item.
Alt+Arrow Down
key combination?
showPrompt
if it's unset.
'recordComponents'
in cells,
rather than just in records.
Layout
, whether a resizeBar
should be shown after this member in the layout, to allow it to be resized.
showRollOver
is true, this property provides an
option to show roll over styling with the rollOverCanvas
and rollUnderCanvas
rather than
using css styling.
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.
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
includes the root
node.
selectionType
is set to "single"
,
setting this property to true means selection will be displayed to the user with the selectionCanvas
and selectionUnderCanvas
rather than using css styling.
appearance
.
labelAsTitle
.
false
to explicitly suppress display of the field title in the column header
button for the field.
showButtonTitle
instead.
title
will be displayed
for this component.title
will be displayed
for this component.title
will be displayed
for this component.title
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.
valueTitle
as a label on the
value axis.
valueTitle
as a label on this
extra value axis.
valueIcons
is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying
showFiscalYearChooser
.
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
.
frozen
fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?true
any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).
record[this.singleCellValueProperty]
is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty]
.
skinDir
.
skinDir
.
skinDir
.
skinDir
.
snapTo
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element.
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
masterElement
(if specified), or its parentElement
.
sortBy
.
displayField
configured, should client-side sorting be performed on the display field
value? Unless explicitly set to false
the display field value is used.
valueMap
is set, and the grid is sorted
by this field, should the data be sorted by the underlying
data value or the mapped display value.
FacetValueMap
of facet values representing a set of facetValues by which the
cubeGrid data is sorted.
headerSpans
, and showHeaderSpanTitlesInSortEditor
is true,
this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the
multi-sort editor
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to sort a field in descending order.
fieldPicker
items be sorted
alphabetically in the drop down list.
separateFolders
is true, should folders be displayed
above or below leaves? When set to true
folders will appear above leaves when the
sortDirection
applied to the tree is ASCENDING
sortFoldersBeforeLeaves
on the data for this treeGrid.
sortBy
.
ListGrid.setSortState
to reset this grid's sort
to the current state (assuming the same fields are present in the grid).WSDL web service
, setting
this flag means the DataSource doesn't actually attempt to contact the server but generates a sample response instead,
based on the XML Schema of the response message embedded in the WSDL.
ChartType
is "Column" then the metric settings may include a setting for stacked
.
memberOverlap
, controls
the z-stacking order of members.
timeline view
.
CalendarEvent
.
CalendarEvent
.
sequence
or an element
which should be the starting point of the process.
baseStyle
as the component changes state and/or is selected.
status
, except DSResponses have additional error
codes, such as validation failure
.
stretching column widths
, should
we stretch all column widths proportionally, or just stretch the columns that need extra width?
canAddSummaryFields
.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
is true, and a summaryRowDataSource
is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row.
showGridSummary
is true, by default summary
values are calculated on the client based on the current data-set for the grid (see ListGrid.getGridSummary
and ListGrid.getGridSummaryFunction
).
ListGrid.setShowGridSummary(Boolean)
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch
request used when retrieving summary data to show in the summary row.
summary row autoChild
.
baseStyle
for the summaryRow
headerTitle
attribute to show a different title in the
column header button than the title used elsewhere.
summaryRow
.
showGridSummary
or showGroupSummary
is true and the summaryFunction
is set to "title"
, this
attribute may be set to a string to display in the group and/or grid summary.
evalResult
is set, setting this property to true causes
autoDraw
to be set to false for the duration of the result
evaluation - which is generally what you want if you're returning new components from the server.
DynamicForm.saveData
on a form or
valuesManager, by default if the server returns an error code, any callback passed into saveData() will not be fired.
ValuesManager.saveData
on a form or
valuesManager, by default if the server returns an error code, any callback passed into saveData() will not be fired.
valueIcons
is set, this property may be set to
prevent the value icons from showing up next to the form items value
<svg>
element equivalent to the current drawing.
show edges
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides).
tab picker button
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition
based on the pickerButtonSrc
property for this tabSet.
tab scroller buttons
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition
based on the scrollerSrc
property for this tabSet.
useTextField
is true
this
property governs the alignment of text within the text field.
textField
.
extra value axes
.
SimpleTile
, CSS style for each value shown within a
tile.
TimeDisplayFormat
for type:"time"
field values displayed in this form.
timeFormatter
or the system-side
timelineGranularity
each
cell represents.
Canvas.getPrompt()
"Cancel"
by default.
"Submit"
by default.
menu for picking visible fields
.
menu for picking visible fields
.
Tree
.
titleEditor
.
titleField
for databound
components."title"
,
"name"
, or "id"
.
title label
in this group.
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.
toDate
is supplied.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to toggle whether a field is frozen or unfrozen.
Canvas.getPrompt()
position
property).
group rectangle
in pixels
relative to the DrawPane.
position
property).
topOperatorForm
.
to
part of the range.
RPCManager.sendQueue
containing the RPCRequest
associated with this response.
transferSelectedData
call.
treeField: true
will display the Tree
.
Validator.setType(ValidatorType)
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field.
headerContextMenu
for this
grid, and this.isGrouped
is true, this attribute will be
shown as the title for the menu item to ungroup the grid.
canRemoveRecords
is enabled, this icon will
be shown in the auto generated field fro removing records if the record has been marked as removed via ListGrid.markRecordRemoved
.
Page.checkBrowserAndRedirect
if they are accessing this page in an unsupported browser and unsupportedBrowserAction
is set to "confirm"
.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set? This attribute will be passed to DataSource#getUpdatedData
as the useDataFromRequest
parameter.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set?
BatchUploader
to map a field in an upload file to this dataSourceField.
uploadFormFields
before they are stored in the
HttpSession on the server.
FileItem
field where the user enters a
filename to upload
operationId
for the "add" operation used to add new
records to the uploadDataSource
.
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.
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.
dataColors
but specify chart-specific gradients based on the primary data color per chart type.
backMask
in Internet Explorer
versions predating Internet Explorer 9.
canSelectCells
is true
fiscal year chooser
, should
firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday,
the calendar will display Tuesday to Monday from left to right.
useFlatFields
, but applies to all DataBound
components that bind to this DataSource.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML message to send to the web service, properties in
request.data
will be used as the values for XML elements of the same
name, at
any level of nesting.
useFlatFields
on an operationBinding is equivalent to setting useFlatFields
on all DataSource requests with the same operationType
as this operationBinding
.
useFlatFields
is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data
will be used as the values for XML elements of the same name, at any level of nesting.
useFlatFields
flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields
XML serialization behavior to be
used for all soap headers in the request.
ID
be applied to the generated
SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID will behave as a synonym
for SectionStackSection.name.
useHttpProxy
, but serves as a default for this
DataSource that may be overridden by individual operationBindings.
HttpProxy
servlet to send requests described
by this operationBinding.
displayField
.
timeFormatter
.
browser-based
offline storage
, and then use those stored responses at a later time if we are offline (ie, the application cannot
connect to the server).
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.
saveLocally
is specified, but this grid is bound to
a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators
will not be executed.true
to ensure these remote validators are called when
saving edits in saveLocally mode.
ListGrid.getRowSpan
has been overriden to introduce spanning
cells, and spanning is largest on the left and smaller as cells go to the right.
ImgTab
tabs?
client-only
or cacheAllData
DataSource to create a second DataSource to perform
it's one-time fetch.
true
when getCriteria
is called, the item will validate the
"to" and "from" fields and return null if either field fails validation.
validators
for this field will
be run whenever the value of the field is changed.
ValidatorType
of "hasRelatedRecord" to every field on this dataSource that has a foreignKey
defined.
drawnValue
represents.
type
to be "header", the
value of this attribute specifies the header text.
multiple value axes
.
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.
valueField
of the combo box.
displayField
values from an optionDataSource
, this property denotes
the the field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an optionDataSource
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
optionDataSource
field used to
retrieve the stored values that are to be mapped to the display values (specified by displayField
).
valueField
for this
item.
valueField
for this
item.
valueField
for this item.
valueField
for this
item.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
is specified, use this property to
specify a height for the value icon written out.
valueIconLeftPadding
valueIconRightPadding
valueIcons
is specified, this property may be
used to specify both the width and height of the icon written out.
valueIcons
is specified, use this property to
specify a width for the value icon written out.
{ item[idField] -> item[displayField] }
, for all items in the list.
{ item[idField] -> item[displayField] }
, for all items in the list.
ValuesManager
for managing values displayed in this component.
Splitbar
is created by a layout to be the resizeBar for
some member of the layout, the vertical
property will be set to true
if the layout is
horizontal, meaning this resizeBar will be taller than it is wide, and will allow horizontal resizing of the member.
Splitbar
is created by a layout to be the resizeBar for
some member of the layout, the vertical
property will be set to true
if the layout is
horizontal, meaning this resizeBar will be taller than it is wide, and will allow horizontal resizing of the member.
this.vertical
is true.
ListGrid.setViewState
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.
canRemoveRecords
is true, when the user clicks
the remove icon for some record, should we show a warning message (defined as warnOnRemovalMessage
) and allow the user to cancel
removal?
canRemoveRecords
is true and warnOnRemoval
is true.
displayField
specified and has no
optionDataSource
, this field will display the
value from the displayField
of each record by default (for more on this behavior see optionDataSource
).
week-based
HeaderLevel
s in this timeline.
TimeUnit
is "week".
TimeUnit
is "week".
mouseWheel
events only.
EventHandler#getWheelDelta()
showNavigation
is true and NavigationMode
is set to "wholeRecord".
group rectangle
in pixels relative to
the DrawPane.
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 String.
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to String.
DataSource.xmlSerialize
should serialize this
value as an XML attribute.
recordXPath
and
valueXPath
XPath expressions.
dataFormat
is "xml", xmlNamespaces
configures the set of namespace prefixes that are added to the document element of the XML message sent to the server.
recordXPath
mapping to the data node of XML returned by the server.
TimeUnit
is "year".
yearSelector
.
TimeUnit
is "year".
previousElement
as next element of workflow.
canvas
is a
dynamicForm.
DynamicForm.getValuesAsCriteria
is called on this item's form? Overridden for ComboBoxItem to return true if generateExactMatchCriteria
is true -
in this case if an exact value is chosen from our set of options (always the case if addUnkownValues
is
false), we will use advancedCriteria to ensure the generated search criteria exactly matches the chosen value for this
item.
AdvancedCriteria
sub criterion object? If this method
returns true, DynamicForm.getValuesAsCriteria
on the form containing this item will always return an AdvancedCriteria
object, calling
FormItemCriterionGetter.getCriterion()
on each item to retrieve the individual criteria.
cacheAllData
is true, has all the data been retrieved
to the client?
DynamicForm.setErrors
or DynamicForm.setFieldErrors
.
DynamicForm.setErrors
or DynamicForm.setFieldErrors
.
storeWithHash
)Window
Header, or SectionStackSection
.Timeline
.Hover.show
canDropComponents
set to true.
icons
array, if it is currently visible.
FormItem.hide
hilite icon
will be placed relative to
normal cell content.canHover
and showHoverComponents
are both true, HoverMode dictates
the type of UI to be displayed when a user hovers over a row or cell.Button
class.IconButton
that shows a menuIcon by default and implements showMenu().MenuButton
class.StretchImg
background.Img
class.cacheAllData
or clientOnly
are true.
this.data.invalidateCache()
.
displayField
, the
value displayed to the user for this item may be derived from another field.
recordComponents
and gets fresh ones for the visible rows in the grid according to the recordComponentPoolingMode
PickTreeItem
which shows an IMenuButton
rather than a simple MenuButton
as it's main button.checkboxField
used when SelectionAppearance
is "checkbox".
record
is expanded or collapsed.
expansionField
used when canExpandRecords
is true.
saveOperationType
is currently
"add".
saveOperationType
is
currently "add".
extra icon
for the current node.
DynamicForm.validate
is called on a component with server-side
validators for some field(s), until the server responds.
rowNumberField
used when showRowNumbers
is true.
includeFrom
fields.JSONEncoder
should do when it encounters a circular reference in an object
structure.canFocus
:
true).
knobs
array.alignable
text
with optional icon
and autoFit
.Timeline
view.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.gridComponents
.ListGrid
.ListGridField
.contentsType
set to "page"
Component XML
format, using the ScreenLoaderServlet
.
Component XML
format, using the ScreenLoaderServlet
.
Component XML
format, using the ScreenLoaderServlet
.
DataSource.load
that will also automatically load any
DataSources that the requested DataSources inherit from
(via {@link com.smartgwt.client.data.DataSource#inheritsFrom DataSource.inheritsFrom))
DataSource.load
that will also automatically load any
DataSources that the requested DataSources inherit from
(via {@link com.smartgwt.client.data.DataSource#inheritsFrom DataSource.inheritsFrom))
here
, if we are unable to find a unique match by name or title, we will use
the recorded "type" of the component to verify an apparent match."$today"
to a RelativeDateString such as "+0D"
destroy()
this canvas on a timeout.
ListGrid.saveEdits
or ListGrid.saveAllEdits
will cause a
"remove" DSRequest
to be submitted.
ListGrid.markRecordRemoved
had been called.
additional value axes
of a FacetChart
.group rectangle
.
MultiFileItem
to
allow the user to enter several files for upload.MultiSortDialog
.SortSpecifier
s.new RelativeDate(RelativeDateShortcut.NOW);
canCloseTabs
is set, this notification method fired
when the user clicks the "close" icon for a tab.
dismissOnOutsideClick
is true, or on
escape keypress if dismissOnEscape
is true.
doubleClickDelay
by default) in this object.
transferSelectedData
completes.
canDrag
is true and canDrag
is true, this notification method will be fired when
the user drags the drawItem
canDrag
is true and canDrag
is true, this notification method will be fired when
the user starts to drag the drawItem
canDrag
is true and canDrag
is true, this notification method will be fired when
the user completes a drag on the drawItem
com.smartgwt.client.widgets.DataBoundComponent.transferSelectedData()
targeting this component completes.
EditorExitEvent.cancel()
from within EditorExitHandler.onEditorExit(com.smartgwt.client.widgets.grid.events.EditorExitEvent)
from this method to cancel the default behavior (Saving / cancelling the current edit / moving to the next
edit cell)
TreeGrid.closeFolder
.
TreeGrid.openFolder
.
iconClick
method will
be fired instead (if specified).
natively submit
a form
is unable to submit to the server.
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 handleHover()
is hidden.
icon
, a separate click handler
for the icon may be defined as this.iconClick
.
iconField
has been specified.
canFocus
:
true).
canFocus
: true).
mouseStillDownDelay
by
default) when the system is idle - i.e.
canExpandRecords
set to true.
canExpandRecords
set to true.
NavigationMode
.
canRemoveRecords
is true.
saveOnEnter
is set and the user presses Enter whilst in a text-item in any clause or subclause.
DynamicForm.setValues
or FormItem.setValue
and may be overridden by CanvasItems
intended to support displaying data values to update the embedded Canvas to reflect the value passed in.
sort specifiers
change
for this grid.
sort button
.
sort button
.
icon
.
ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
ListGrid.setCanExpandRecords(Boolean)
with ListGrid.setExpansionMode(com.smartgwt.client.types.ExpansionMode)
, or override ListGrid.getExpansionComponent(ListGridRecord)
Criterion
when specifying AdvancedCriteria
.Criterion
that uses this operator.Page.setEvent
FormItem.formatEditorValue
and FormItem.parseEditorValue
methods.
BatchUploader
whilst it still contains errors.percentBox
.Portlet
windows.Canvas.getPrintHTML(PrintProperties, PrintHTMLCallback)
Window
used for displaying a printable view.state
across the different tasks that are executed.Process
,
such as a Task
or XORGateway
.dataProtocol
.
ProcessElement
s involved in a Process
.grid summary
, by either re-calculating
from already-loaded data or doing a new fetch from the summaryRowDataSource
.
summary-functions
defined and for values displayed in the grid summary
and group summary rows
.
summary-functions
defined and for values displayed in the grid summary
and group summary rows
.
DataBoundComponent
.recordComponents
.ListGrid.markRecordRemoved
ListGridField.showIf
for each field,
dynamically showing and hiding the appropriate set of fields
recordComponent
and gets a fresh one for the specified record (or cell) according to the recordComponentPoolingMode
recordComponent
and gets a fresh one for the specified record (or cell) according to the recordComponentPoolingMode
PropertyHelper
.
RelativeDateItem
class.timelineView
mode.
timelineView
mode.
Portlet
which is currently rendered in this PortalLayout.
sectorIndex
.
DataSource.transformRequest(DSRequest)
when
instantiating a DataSource on the client.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
.
ListGrid.unsort
, this method will resort the list by the previous
sort-specifier
array, if there is one, or by the previous
sort-field and -direction.
DataSource.transformResponse(DSResponse, DSRequest, Object)
} when
instantiating a DataSource on the client.Window.minimize
or Window.maximize
.
RecordList
that automatically fetches
DataSource records when items are requested from the List.Tree
API, used to handle hierarchical
data, whose nodes are DataSource records which are retrieved from a server.ToolStrip-based
class for showing groups
of related buttons and other controls.RibbonBars
.startRow
to false
to create a rowSpacer
that simply takes up every remaining column in the current row rather than starting a new row.allowRowSpanning
is enabled, certain cells
may span multiple rows.DataSource
this form is
bound to.
DataSource
this form is
bound to.
DataSource
this form is
bound to.
canEditTabTitles
), save the edited tab title and hide the editor.
isc.defineClass
, including Classes built into Smart GWT, such as "ListGrid".<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)
.src
and icon
, are specially interpreted in Smart GWT to allow for simpler and more
uniform image URLs, and to allow applications to be restructured more easily.DynamicForm
.facets
or facetValues
.Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
s passed in explicitly, or by index.
Record
passed in explicitly, or by index, and deselect everything else.
Record
passed in explicitly, or by index, and deselect everything else.
useTextField
is true, falls through to
standard FormItem.selectValue
implementation on
this items freeform text entry field.
DMI
(Direct Method Invocation).Process
which calls a DataSource operation,
optionally using part of the process state
as inputs or
storing outputs in the process state.baseStyle
for all cells
for this particular record.
edgeStyleName
will be treated as a
base style name and appended with following suffixes to support separate styling per cell:
add event
toolbar button
AdvancedCriteria
on
fetch or filter type operations.
addUnknownValues
is
false
, this property determines whether the user can clear the comboBoxItem value, or whether they are
constrained to choosing one of the available options (in which case clearing the text box will simply revert to the last
picked value when the user leaves the field).
form.getValuesAsCriteria()
), allows the user to enter simple expressions in any field in this form that takes text
input.
form.getValuesAsCriteria()
), allows the user to type in simple expressions to cause filtering with that operator.
allowExternalFilters
setting.
showFilterEditor
:true, allows simple
search expressions to be entered into filter fields, as though allowExpressions
were true.
eval()
function, objects created
within that evaluation are not released from browser memory until the page is
reloaded.
DataSource
s that have
a primaryKey
, and all primary key values are present in
the request.
RelativeDateItem
s) or whether dates are absolute (via DateItem
s).
true
, the ListGrid.getRowSpan
method will be called for every cell when
rendering out the listGrid to determine how many rows the cell should span.
alternateRecordStyles
is true for this grid.
alternateWeekStyles
.
alt
text for the image HMTL element.
optionDataSource
and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField
is specified and the
new item value is not present in any valueMap explicitly specified on the item.
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.
canRemoveRecords
is enabled, should records
be animated out of view when they are removed by the user?
animating record removal
, this property
designates the speed of the animation in pixels per second.
(see
animateRemoveRecord)
, if animateRemoveSpeed
is
not set, this property designates the duration of the animation in ms.
showRollOverCanvas
is true
setting this property to true ensures that when the rollOver canvas is displayed it animates into view via an Canvas.animateShow
.
showRollOverCanvas
is true
setting this property to true ensures that when the rollUnder canvas is displayed it animates into view via an Canvas.animateShow
.
showSelectionCanvas
is true
setting this property to true ensures that when the selection canvas is displayed it animates into view via an Canvas.animateShow
.
showSelectionCanvas
is true
setting this property to true ensures that when the selectionUnder canvas is displayed it animates into view via an
Canvas.animateShow
.
Canvas#animateShow()
is called without an explicit effect parameter.
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?
HTML fragments
, loadable views
, XML or JSON flat data files, videos, etc.
HTML fragments
, loadable views
, XML or JSON flat data files, videos, etc.
appImgDir
.
prompt
is specified for this item, should the
prompt be applied to the canvas
for this item?
cacheAllData
:true and a fetch
results in the entire dataset being retrieved, this attribute being set to true causes the DataSource to automatically
switch to cacheAllData:true and prevent further server-trips for fetch requests.
autoPosition
is false, this property controls
whether to automatically center the colorPicker every time it is reshown with the show() method.
field.name
for
any field that does not have a field.title
and is not marked
hidden
:true, by calling the method DataSource.getAutoTitle
.
canvas
be automatically
destroyed when the item is destroyed? Form items are destroyed automatically when a call to DynamicForm.setItems
removes them from their parent form, or if
their parent form is destroyed.
destroyed
, should it also destroy its menu
?
destroyed
, should it also destroy its menu
?
DataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be
performed via DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
DataBoundComponent.fetchData()
or DataBoundComponent.filterData()
depending on
DataBoundComponent.getAutoFetchAsFilter()
.
dataSource
, should options be fetched from the server when
the item is first written out, or should this fetch be delayed until the user opens the pickList.
data source
immediately or wait until the
user first opens the pickList.
dataSource
, should options be fetched from the server when
the item is first drawn, or should this fetch be delayed until the user opens the pickList.
optionDataSource
is
specified, a valueMap will be automatically created by making a DataSource.fetchData
call against the specified dataSource and extracting a valueMap from the returned records based on
the displayField and valueField.
optionDataSource
.
autoFetchData
is true
, this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData()
call.
loadDataOnDemand
:true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact"
.
headerContextMenu
for this
grid, and canAutoFitFields
is true, this
attribute will be shown as the menu item title for an item to perform a one-time autoFit of all visible fields via the
ListGrid.autoFitField
method.
autoFitFieldWidths
is enabled and the
calculated field sizes are wide enough that horizontal scrolling would be introduced, this attribute may be set to an
array of fieldNames, causing those fields to be clipped rather than forcing horizontal scrollbars to appear.
autoFitFieldWidths
and
autoFitFieldsFillViewport
are enabled and
auto-fitting will not fill all available horizontal space.
autoFitData
is set to "vertical"
or
"both"
this property specifies the number of additional records for which the grid will expand.
autoFitFieldWidths
is enabled, and extra
space is available after autofitting all fields, should the grid automatically expand one field to fill the extra space.
headerContextMenu
for this
grid, and canAutoFitFields
is true, this
attribute will be shown as the menu item title for an item to perform a one-time autoFit of the field to its title or
content via a call to ListGrid.autoFitField
.
type:"icon"
, fields displaying only value icons
, and boolean fields (which are rendered
as a checkmark type icon by default.
autoFitData
is set to "horizontal"
or
"both"
this property provides the maximum number of columns for which the ListGrid will expand.
autoFitData
is set to "vertical"
or
"both"
this property provides an upper limit on how far the ListGrid will expand vertically to accommodate
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
accommodate its content.
header contextmenu
or via a mouse gesture
, what autofit approach is used.
header contextmenu
or via a mouse gesture
, what autofit approach is used.
dynamicForm.focusInItem(itemName)
Tree.setRoot
is called.
saveByCell
is true).
headerSpans
, setting
this attribute to true will cause spans to expand to accomodate long titles if necessary.
"OK"
-click, and refuse to dismiss if these items contain invalid values.
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?
single-column mode
, this i18n
property dictates the title for the button
docked to
the top left which allows navigation back through the column tree.
showBackgroundComponent
is true
.
showBackgroundComponent
is true
.
fiscal
year column
.
capSize
for the BaseLine
stretchImg.
src
for the BaseLine
StretchImg.
base cell style
for this listGrid.
baseStyle
will be applied to the button.
base cell style
for this listGrid.
baseStyle
To override the baseStyle at the row level, use
record[listGrid.recordBaseStyleProperty]
instead.
fiscal week
column
.
booleanTrueImage
, booleanFalseImage
and booleanPartialImage
.
booleanTrueImage
, booleanFalseImage
and booleanPartialImage
.
browserSpellCheck
toolbar
, if shown.
cacheAllData
or client-only DataSource, a set of
records to use as a dataset, specified as an Array of JavaScript Objects representing records.
dataTransport
:"scriptInclude".
scriptInclude
transport, this attribute
specifies the name of the URL parameter which is used to specify the callback function that
the server is expected to call by writing out JavaScript code.
false
, other records cannot be dropped on (i.e., inserted via drag and drop) immediately before
this record.
treeNode
s) may be dropped over this node.
com.smartgwt.client..FormulaBuilder
.
com.smartgwt.client..SummaryBuilder
.
headerAutoFitEvent
.
warnOnCancel
is true.
this.confirmCancelEditing
is true this property is used as the message
to display in the confirmation dismissal prompt.
targetForm
or targetVM
had cancelEditing()
called on it.
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.
visibilityMode
"mutex", whether to allow
the last remaining expanded section to be collapsed.
groupIcon
) and clicking the icon or double-clicking the group
title will collapse or expand the group.
canDrag
for this to have an effect.
canDrag
.
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 dragability.
Layouts
, except that members are added as items into the
section over which they're dropped.
CanvasItem.setCriterionGetter
.
canEditCriterion()
predicate is overridden in comboBoxItem.
canEditCriterion()
predicate returns true if the specified criterion contains:
A single "lessOrEqual" or "greaterOrEqual" criterion on this
field An "and" type criterion containing a "lessOrEqual" and a "greaterOrEqual" criterion on this
field A single "equals" criterion.
DynamicForm.setValuesAsCriteria
, this predicate is used
to determine which sub-criteria apply to which form item(s).
CalendarEvent
that determines editability.
laneNameField
? If so, the event can be dragged to a
different lane
and, when it's editor is shown, an
additional drop-down widget is provided allowing the user to select a different lane.
titleEditEvent
fires.
canEditTabTitles
setting,
for this one tab only.
canExpandRecords
is true, this property
indicates whether multiple records can be expanded simultaneously.
StaticTextItem
will cause the item to be included in the page's tab order and
respond to keyboard events.
dataSource
, and useAllDataSourceFields
is false, setting this
property to true will cause all dataSource fields not included in the specified set of fields to show up in the field picker menu item
.
removeIcon
, which, when clicked, will call ListGrid.removeRecordClick
which removes the row from the
data set (or if deferRemoval
is true changes the
ListGrid.markRecordRemoved
status for the record).
canReorderSections
is true.
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.
Portlets
be drag-resizable?
canResizePortlets
instead.
selectionAppearance
set to "checkbox"
cell-level rollover
.
Portlets
.
SectionItems
will be
included in the page's tab order for accessibility.
CanvasItem
, this property will be
set to point at the item.
autoDismiss
from this menu.
align
.
DynamicForm.setCellPadding(int)
instead
cellStyle
change
handler
(and store its value in the form) on every keypress? Set to false
to suppress the 'change' handler firing
(and the value stored) on every keypress.
change
handler
(and store its value in the form) on every keypress? Set to false
to suppress the 'change' handler firing
(and the value stored) on every keypress.
FormItem.setValue
.
CubeGrid.makeChart
is called with a chart specification
that will show more than chartConfirmThreshold
data elements, the user will be presented with a confirmation dialog
.
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, and
Radar charts are supported.
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, and
Radar charts are supported.
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for an unselected row.
checkbox field
leave around the checkbox icon when selectionAppearance
is set to "checkbox"
?
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 partially selected
row.
#setSelectionAppearance(),selectionAppearance
is set to "checkbox".
selectionAppearance
is set to
"checkbox"
this property determines the image to display in the checkbox field for a selected row.
expansionModes
that show another grid or tree, what the child's
expansionMode should be.
multiple:"true"
, controls the name of
the XML tag used for each subelement during DataSource.xmlSerialize
.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to clear any existing sort on all fields.
headerContextMenu
for this
grid, and a filter-editor
is visible, this
attribute will be shown as the menu item title to clear any existing filter.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to clear an existing sort on this field.
DSRequests
are executed on it.
showCloseConfirmationMessage
is true.
folderIcon
for
closed folders.
folderIcon
for
closed folders.
closeIcon
for this tab.
canCloseTabs
is true.
canCloseTabs
is true.
code
attribute is relative
baseStyle
for the buttons in this grid's column headers.
ids
for facets that will appear on top of the body.
overflow
setting for each column.
preventColumnUnderflow
and
reflows the layout to implement it.
column
in this columnTree.
ComboBoxItem
.
ComboBoxItem
.
Tab
key.
DataBoundComponent
, the ID
of the submitting component.
headerContextMenu
for this
grid, and multi-sorting is enabled, this attribute is used as the title for a menu item that opens a MultiSortDialog
to configure the sort-specification for this grid.
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.
inline view
property.
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 STATUS_LOGIN_INCORRECT
rather than a call
to 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
.
treeField
set to true
to show the tree.
TileGrid
that created this SimpleTile.
AdvancedCriteria
to be applied to the task inputs.
operator
, the name of the DataSource
field for the Criterion
this FormItem generates.
ID
to Criteria that will cause this
ProcessElement to be chosen as the next element if the criteria matches.
ResultSet
cache should be dropped when the criteria
changes.
Criteria
changes.
setCriterion()
method
of the FormItemCriterionSetter
that is registered with this field.
AdvancedCriteria
objects using nested
DynamicForms.
getCriterion()
implementation returns criterion derived from the current value of this item.
DynamicForm.getValuesAsCriteria
.
getCriterion()
implementation returns the Criterion entered in the fields shown in the rangeDialog
.
setCriterion()
implementation to display a Criterion
object in this item for editing.
setCriterion()
implementation is overridden to support editing criterion against the display field
or value field when addUnknownValues
is true.
setCriterion()
implementation applies the specified criterion to this item for editing.
default node.showDropIcon
property.
default node.showOpenIcon
property.
default node.showOpenIcon
property.
default
node.icon
property.
serverType
"sql" or "hibernate",
indicates that this field should be omitted by default from all SQL or Hibernate operations, and will only be used with
custom queries
.
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.
DataBoundComponent
needs to show a short summary of a record.
RecordLayout
s.
DataSource.fetchData
is called).
showDataPoints
).
showDataPoints
).
ResultSet
object created for this grid when data is fetched
DataSource
is this resultSet associated with?
data
/menu.items.
DataSource
is this resultTree associated with?
specified month
when this fiscal
year starts.
DateDisplayFormat
for Date type values displayed in this form.
useTextField
is true
this
property can be used to customize the format in which dates are displayed for this item.DateDisplayFormat
.
valueField
and calculatedDateField
.
valueField
and calculatedDateField
in some custom format.
DateUtil.parseInput(String)
).
inputFormat
applied to editors for fields of type "date"
3 character string containing the "M", "D" and "Y" characters to indicate the format of strings being parsed into Date instances via Date.parseInput().
date picker
toolbar button
DateDisplayFormat
for Date type values displayed in this form in fields of
type datetime
.
TimeUnit
is "day".
daySelector
.
TimeUnit
is "day".
decimalPrecision
used to render the numeric
labels of this metric axis.
specified
month
to use for calculating fiscal dates when no fiscal years
are provided.
field.groupingMode
is unset.
defaultIconSrc
.
minimizeHeight
is unset, by the window will shrink to
the height of the header when minimized.
fiscal years
are provided.
titleProperty
value or
a nameProperty
value.
quantityField
.
canRemoveRecords
causes records to be marked for future removal via ListGrid.markRecordRemoved
instead of immediately being removed.
CalendarEvent
The name of this
field within the CalendarEvent can be changed via descriptionField
CalendarEvent
.
RecordLayout
s except
"titleOnly".
destroy()
when closing the Portlet.
destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab
}.
DataBoundComponent
.
canExpandRecords
is true and listGrid.expansionMode
is "related"
, this property specifies the
dataSource for the related records grid to be shown embedded in expanded records.
canExpandRecords
is true and listGrid.expansionMode
is "related"
, this property specifies the
dataSource for the related records grid to be shown embedded in expanded records.
recordDetailDSProperty
.
canExpandRecords
is true
and listGrid.expansionMode
is detailField
.
detailToolStrip
.
DetailViewer
that is automatically created to render the
contents of tiles by default.
disabled
.
disabled
.
canEdit
is set to false, should icons
be disabled by default?
canEdit
is set to false, should icons
be disabled by default?
canEdit
is set to false, should this icon be
disabled.
request queuing
for this RestDataSource.
confirmDiscardEdits
is true this is the
title for the save button appearing in the lost edits confirmation dialog.
parentIdField
which doesn't map to a valid parent node be
dropped? If set to false, for loadDataOnDemand
:false trees, parentless nodes will be added as children of the root node - for loadDataOnDemand
:true, they will be added as children of
the folder currently requesting children.
modelType:"parent"
, should nodes in the data
array for the tree be dropped if they have an explicitly specified value for the parentIdField
which doesn't match any other nodes in the tree.
displayField
of the combo box.
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.optionDataSource
field used to
retrieve the display values that are to be mapped from the internal values specified by valueField
.
displayField
is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name
of the field.
DateDisplayFormat
or a function which will return a formatted date time string.
"date"
or "time"
will be edited using a DateItem
or TimeItem
by
default.
"date"
or "time"
will be edited using a DateItem
or TimeItem
by
default.
TimeItem.setDisplayFormat(TimeDisplayFormat)
instead.
displayField
is set, should this field show
record values from the displayField
?
showRecordComponents
is true, by default
any created record components are destroyed once they are no longer in use (for example in the ListGrid as a whole is
destroyed).
showDoughnut
),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.
a new browser
window
.
downloadResult
is true, setting this attribute to true
causes the content of the downloaded file to be displayed in a new browser window.
"target"
, this value specifies the opacity to render the target while it
is being dragged.
canDragReposition
is true, this attributes specifies
the visual appearance to show during drag reposition.
canDragResize
is true, this attributes specifies the
visual appearance to show during drag resize.
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.
DrawGroup
this drawItem is a member of.
DrawPane
this drawItem should draw in.
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
.
dropTypes
is set to ["PortalColumn"]
in order to allow the dragging of columns within the
PortalLayout
.
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
Smart GWT will apply to the dropped object before updating it.
preventDuplicates
is enabled.
setCriterionGetter()
whereby if this item
contains a DynamicForm as its canvas, it will be used to edit nested AdvancedCriteria automatically.
ListGridEditEvent
for options.
this.editFailedCSSText
this.editFailedBaseStyle
instead.
TextItem
iconHeight
.iconHeight
instead.
iconWidth
.iconWidth
instead.
imageURLPrefix
to the editor in question.
imageURLSuffix
to the editor in question.
FormItemValueFormatter
to map this item's current data
value to a display value.
FormItemValueFormatter
to map this item's current data value to a
display value.
FormItemValueParser
to map a user-entered display value to a data
value for storage.
FormItemValueParser
to map a user-entered display value to a data
value for storage.
this.editPendingBaseStyle
instead.
ProcessElement
s in this sequence.
emptyMessage
if
displayed.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
hideEmptyPickList
is false
.
CalendarEvent
The name of
this field within the CalendarEvent can be changed via endDateField
CalendarEvent
.
fixedRecordHeights
is set, vertical clipping is not enforced by default for some kinds of content (such as images) on
all browsers.
enterKeyEditAction
as
specified at the listGrid level while focus is in this field.
EnumTranslateStrategy
is set to "bean".
type "enum"
in the DataSource, by default a newly edited row
will use those filter criteria as initial values.
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 accommodate the error message and icon.
showInlineErrors
is true, where
should the error icon and text appear relative to the form item itself.
showInlineErrors
is false we show all errors
for the form item in a single item rendered at the top of the form.escapeKeyEditAction
as
specified at the listGrid level while focus is in this field.
EscapingMode
expected for escaping special characters embedded in text values.
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
.
eventWindowStyle
for an individual CalendarEvent
.
showHeader
is set to false
in which
case they default to the expanded state.
LayoutPolicy
:"fit", should margins be expanded so that tiles fill the available
space in the TileLayout on the breadth axis? This can also affect tileWidth
or tileHeight
.
expansionModes
that show another grid or tree, is that component
editable?
canExpandRecords
is true and expansionMode
is editor, the prompt to display in a
dialog when an expanded row is collapsed while it's nested editor has changed values.
canExpandRecords
is true and expansionMode
is editor, whether a dialog should be
displayed when an expanded row is collapsed while it's nested editor has changed values.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for collapsed rows.
canExpandRecords
is set to true
,
this property may be set to govern the height of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property may be set to govern the width of the expansion image displayed to indicate whether a row is expanded.
canExpandRecords
is set to true
,
this property determines the image to display in the expansion field for expanded rows.
ExpansionMode
for records in this grid.
DataBoundComponent.exportClientData
.
XLS
and OOXML
.
exportToFilesystem
is set, optionally specifies a
path to use when saving the file.
exportClientData()
.
exportClientData()
.
exportFilename
and
exportAs
respectively.
exportFilename
and
exportAs
respectively.
ListGrid
that has headerSpans
, should headerSpans also be exported.
ListGrid
that has headerSpans
defined and exportShowHeaderSpanTitles
is true, the behavior is
dependent on the export type.
exportDisplay
.
DataBoundComponent.exportClientData
.
extra axis metric
is plotted.
TreeGrid.getExtraIcon
) or checkbox icon and the nodeIcon
/
folderIcon
or node text.
CubeGrid
, and it has a facetId property specified then
the Cube treats this as adding that facetId at the drop location.
this.showHover
is true, this is the default height to apply to hover tips shown for
facetLabels.
this.showHover
is true, this is the default width to apply to hover tips shown for
facetLabels.
this.showHover
is true, this is the default height to apply to hover tips shown for
facetValues.
this.showHover
is true, this is the default width to apply to hover tips shown for
facetValues.
type
.
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.
optionDataSource
and this property is true
, the list of fields
used by this pickList will be passed to the datasource as outputs
.
optionDataSource
and this property is true
, the list of fields
used by this pickList will be passed to the datasource as outputs
.
optionDataSource
, should the item ever perform a fetch against this dataSource to retrieve the related record.
cellIcon
for a field after the grid is
created
dataSource
.
icon
for a field after the grid is created
Record
that this criterion applies to.
fieldPicker
autoChild FormItem.
field-picker
select-item.
field-picker
select-item.
ListGrid.getFieldState
.
TileGrid.getFieldState
.
headerContextMenu
for this
grid, and this.canPickFields
is true, this attribute
will be shown as the title for the menu item which contains a submenu with items allowing the user to show and hide
fields in the grid.
showFilterEditor
is true, this attribute may be
used to customize the filter button shown to the right of the filterEditor row.
showFilterEditor
is true, this method will
update the criteria shown in the filterEditor
without performing a filter.
filterEditor
if showFilterEditor
is true.
data property
set to a static array of
records, should ListGrid.filterData
filter this array? If
this property is set to true, the local data array will be filtered according to the specified criteria, and the results
displayed.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
optionDataSource
, displayField
and fetchMissingValues
), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch
the entire set of options from the server, and use these values to map the item value to the appropriate display
value.
filterLocally
is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value.
FilterEditor
showing, the Operator to
use when matching values for this field.
showHeaders
is set
(the remaining columns have their titles derived from the item selected in the column to the left).
com.cmartget.client.widgets.FiscalCalendar
for use when working with Dates.
FiscalCalendar
object that will be used by this DateChooser.
FiscalCalendar
object that will be used by this DateChooser.
FiscalCalendar
object that will be used by this item's DateChooser.
FiscalCalendar
object that will be used by this item's DateChooser.
FiscalYear objects
which each represent the start date of a
single fiscal year.
single-facet
chart of an extra value axis,
this property provides a constant facet value for the second facet.
single-facet
chart of an extra value axis,
this property provides a constant facet value for the second facet.
FacetValueMap
describing the set of facet values that should be regarded as
"fixed" in this cubeGrid.
ForceTextApproach
unless they have a
specific setting for DataSourceField.exportForceText
.
formatEditorValue
re-run whenever
this item recieves or loses focus? Setting this property allows developers to conditionally format the display value
based on item.hasFocus, typically to display a longer, more informative string while the item does not have focus, and
simplifying it down to an easier-to-edit string when the user puts focus into the item.
natively
submit
a form is unable to submit to the server.
headerSpans
, and showHeaderSpanTitlesInFormulaBuilder
is true, this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid in
the FormulaBuilder and SummaryBuilder.
formula
String to the fieldNames these variables should represent in
the context where the formula is evaluated.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze a currently unfrozen field.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze fields on the left of the scrollable body.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to freeze fields on the right of the scrollable body.
fromDate
is supplied.
from
part of the range.
extra value axes
.
showGridSummary
is true, this attribute will be
set to true on the record object representing the grid summary row.
gripImgSuffix
to simplify providing custom
grip media for this widget.
showGrip
is true.
showGrip
is true.
ComponentSchema
, indicates what group to place the property in when editing
in Visual Builder.
grouped
, and showGroupSummary
is true, this attribute may be set to an
array of groupBy field names for which group summaries should appear.
headerContextMenu
for this
grid and this.canGroupBy
is true, this string will be
shown as the title for the menu item to toggle the group by setting for a field.
grouping modes
,
the current grouping mode.
ListGrid.getGroupState
.
showGroupSummary
is true, this attribute will
be set to true on each record object representing a group-level summary row.
customStyle
for the group-level summary row
displayed when showGroupSummary
is true.
ToolStripGroups
.
groupTitleColumn
.
grouped
, each group shows under an auto
generated header node.
ToolStripGroups
.
baseStyle
to apply to the buttons in the header, and the sorter,
for this ListGrid.
headerBaseStyle
.headerTitleStyle
as well.
headers
shown above the event area,
and their time units.
showHeaderMenuButton
is true, this property
governs the height of the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the height of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the icon shown on the auto-generated headerMenuButton
showHeaderMenuButton
is true, this property
governs the width of the auto-generated headerMenuButton
headerSpan
dynamically.
headerSpan
with no height
specified.
headerSpan
dynamically.
showHeaderBackground
is true
, this
property provides the URL of the background image for the header.
titleStyle
to apply to the buttons in the header, and
the sorter, for this ListGrid.
headerTitleStyle
.headerButtonConstructor
is set to StretchImgButton
or a subclass thereof.
group rectangle
in pixels relative to
the DrawPane.
rowHeight
(if no rowHeight is set).
rowHeight
(if no rowHeight is set).
type
: "separator"
, this attribute
specifies the height of the separator.
hideEmptyFacetValues
, controls on which
axis hiding of empty values is applied, "row" (only empty rows are hidden), "column" (only empty columns are hidden) or
both (the 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.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
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.headerSpans
, and showHeaderSpanTitlesInHiliteEditor
is
true, this string will be inserted between the headerSpan title and the field title in the hiliteEditor field chooser
grid.
showHeaderBackground
is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashed
hilite
icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconLeftPadding
hilite icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconLeftPadding
hiliteIcons
are present, where the hilite icon
will be placed relative to the field value.
hiliteIcons
are present, where the hilite icon
will be placed relative to the field value.
hiliteIcons
are present, where the hilite
icon will be placed relative to the field value.
hiliteIcons
are present, where the hilite
icon will be placed relative to the field value.
hilite
icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconRightPadding
hilite icons
by default? Can be overridden at the field level
hilite icons
for this field? Overrides hiliteIconRightPadding
hilites
.
hilites
.
hilite icons
for this
component.
hilite icons
in this field.
hilite icons
for this
component.
hilite icons
in this
field.
TimeUnit
is "hour".
TimeUnit
is "hour".
this.showHover
is true, this property can be used to customize the alignment of content in the hover
canvas.
this.showHover
is true and Canvas.getHoverComponent
is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden?
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.
showValueOnHover
is enabled.
showHoverComponents
is true, the builtin
mode to use when automatically creating a hover component for rows in this grid.
this.showHover
is true, should this widget's hover canvas be moved with the mouse while visible?
this.showHover
is true, should the hover canvas be shown with opacity other than 100?
this.showHover
is true, this property can be used to specify the css style to apply to the hover canvas.
this.showHover
is true, this property can be used to customize the vertical alignment of content in the
hover canvas.
this.showHover
is true, this property can be used to
customize the width of the hover canvas shown.
this.showHover
is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps.
vertical
is false, and src
is unset.
vertical
is false and src
is unset.
vertical
is false and src
is unset.
htmlElement
is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement
in the DOM.
message
.
Orientation
.
type
:"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.
icon
is specified, this property may be used to specify a size
for the icon
"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.
icon
is specified, this property may be used to specify a size
for the icon.
iconVAlign
.
icon
is specified, this property can be used to
specify the width of the icon to be displayed in the ListGrid header button.
icon
is specified, this property may be used to specify a size
for the icon
Gateway
s, or as the startElement
.
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.
generateClickOnSpace
, generateClickOnEnter
,
generateDoubleClickOnSpace
, generateDoubleClickOnEnter
and arrowKeyAction
).
items
for this stretchImg display left-to-right even
if this page is displaying right to left text
?
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
valueIcons
when determining the URL for the image.
ListGridFieldType
] set to "image"
and the URL for
the image displayed is not absolute, the path of the URL will be relative to this stringvalueIcons
when determining the URL for the image.
"image"
and the URL for the image displayed is not absolute, the path of the
URL will be relative to this stringvalueIcons
when
determining the URL for the image.
valueIcons
) or this is has ListGridFieldType
set to "image"
, this the value of this property will be
appended to the end of the URL for the icon displayed.".gif"
to the filename of the image.imageURLSuffix
.
imageType
settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
delay
, as well as when the entire form is submitted.
delay
, as well as when the entire form is submitted.
implicitSave
is true, this attribute dictates
the millisecond delay after which form items are automatically saved during editing.
ComponentSchema
, a field inherited
from another schema can be redeclared with this property
set in order to indicate that the property should not be used.
omitControls
.
summary row
for this grid.
grid summary
.
treeField
column, should the component be indented to the position where a title would normally show?
DataBoundComponent
needs to show a short summary of a record.
RecordLayout
s.
fields
from.
DataBoundComponent.setAutoFetchData(Boolean)
is used.
baseStyle
for the buttons in the innermost column header for
this cubeGrid.
process state
which is provided as input data to
this task.
process state
which are
provided as input data to this task.
useTextField
is true
this
property can be used to specify the input format for date strings.
"date"
, if this is an editable field such as a TextItem
, this property allows you to specify the inputFormat
applied to the item.
useTextField
is true
this
property can be used to specify the input format for date strings.
"date"
, if this is an editable field such as a TextItem
, this property allows you to specify the inputFormat
applied to the item.
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.
showGridSummary
, showGroupSummary
or listGridFieldType:"summary"
), and the summary function returns
"null"
(implying it was unable to calculate a valid summary value).
true
to explicitly mark this node as a folder.
showGridSummary
is true.
showGroupSummary
is true.
canRemoveRecords
is true, this
field will be rendered as the remove-field for this grid.
true
, defines a horizontal separator in the
listGrid object.
true
, this menu item shows a horizontal separator instead of the title
text.
record[this.isSeparatorProperty]
is set for some record, the record will be displayed as a simple
separator row.
DynamicForm.setFields(com.smartgwt.client.widgets.form.fields.FormItem[])
.
data
Synonym for Menu.setData(com.smartgwt.client.widgets.menu.MenuItem...)
.
recordXPath
mapping to the data node of json returned by the server.
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout overview
).
lane
this CalendarEvent
should sit in.
lane
in
which this event will be displayed for the timelineView
Orientation
is "vertical".
showHeaderMenuButton
is true, when
auto-fitting fields to the title width via autoFitFieldWidths
or autoFitWidth
, should the
button be sized such that there is enough space for the heeader menu button to show without covering the field title?
showHeaderMenuButton
is true, when
auto-fitting fields to the title width via autoFitFieldWidths
or autoFitWidth
, should the
button be sized such that there is enough space for the heeader menu button to show without covering the field title?
selectionAppearance
:"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent?
position
property).
position
property).
group rectangle
in pixels
relative to the DrawPane.
Icon
for the leftButton
leftButtonIcon
LeftButtonIcon
.
Title
for the leftButton
leftButtonTitle
leftButtonTitle
.
ListGridFieldType
] set to "link"
, setting this
property will apply a standard prefix to the link URL for cells in this field.
"link"
, setting this property will apply a standard prefix to the link URL
when displaying values of this field.
ListGridFieldType
] set to "link"
, setting this
property will apply a standard suffix to the link URL for cells in this field.
"link"
, setting this property will apply a standard suffix to the link URL
when displaying values of this field.
contentsURL
property has been set.
loadingMessage
.
LocatorTypeStrategy
to use when finding children within this canvas.
"title"
use the title as an identifier within this
form "value"
use the value of the item to identify it (often used for items with a static
defaultValue such as HeaderItems "index"
use the index within the form's items array.
LocatorTypeStrategy
to use when finding members within this layout.
LocatorTypeStrategy
to use when finding peers of this canvas.
LocatorTypeStrategy
to use when finding Sections within this section Stack.
ID
this will always be used.
useLogGradations
, base value for
logarithmic gradation lines.
useLogGradations
, base value for
logarithmic gradation lines.
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 0 and logBase
.
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase
.
this.longTextEditorType
(a TextAreaItem by default), rather than a simple
text item.
length
exceeds this
value, the ListGrid shows an edit field of type longTextEditorType
rather than the standard text field when the field enters inline edit mode.
length
exceeds
this.longTextEditorThreshold
show an edit field of this type rather than the standard text field when the
field enters inline edit mode.
layoutMargin
.
useTextField
and useMask
are both true
this value is the
separator between date components.
topOperatorAppearance
:"radio".
topOperatorAppearance
:"radio".
htmlElement
is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?topOperatorAppearance
:"radio".
canExpandRecords
and canExpandMultipleRecords
are both true, this
property dictates the number of records which can be expanded simultaneously.
\${...}
will be evaluated as JS code when the message is displayed.
MenuButton
generated for it automatically (for example
when included in a MenuBar
, the width that the MenuButton should have.
menu
when clicked.
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.
TimeUnit
is "millisecond".
TimeUnit
is "millisecond".
canvas.animationTime
.
TimeUnit
is "minute".
TimeUnit
is "minute".
TimeUnit
is "month".
monthSelector
.
TimeUnit
is "month".
showMoreTab
is enabled
and the number of tabs to show exceeds moreTabCount
.
showMoreTab
is enabled this property determines the
image to display on the "More" tab button.
"move"
control
knob
, this attribute
specifies where the knob should appear with respect to the drawItem.
multiple
set to 'true' be
displayed?
field.type
.
CalendarEvent
The name of this field
within the CalendarEvent can be changed via nameField
laneNameField
property on the CalendarEvent.
ListGrid.setHeaderSpanTitle
.
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.
showNavigation
is true and NavigationMode
is set to "navIconOny".
navigationBar
managed by this widget.
icon.neverDisable
is true, when this form item is disabled, the icon will remain enabled.
ResultSet.setCriteria(com.smartgwt.client.data.Criteria)
are applied to it, and it may disappear from the cache.
neverUseFilters
setting.
next
toolbar button
sequence
or element
to execute after this one completes.
sequence
or {process.elements,element} to
procede to if no error condition arises.
sequence
or {process.elements,element} to
procede to if the criteria match the process state.
Page.isRTL
is true.
Page.isRTL
is true.
xsi:nil
being used to transmit the value when serializing
to XML, like so:
baseStyle
is unset, base style will be derived from
normalBaseStyle
if this grid has fixed row heights
and the specified cellHeight
matches this value.
DateUtil.setNormalDateDisplayFormatter(DateDisplayFormatter)
.
StaticTextItem
or DetailViewer
.
offlineMessage
if
displayed.
update
or remove
operation, the original values from the record that is being updated
or removed.
update
or remove
operation, the original values from the record that is being updated
or removed.
update
or remove
operation, the original values from the record that is being updated
or removed.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.
Tree.isOpen
to determine if the node is open or not.
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.
RelativeDateItem.getCriterion
the
FormItemCriterionGetter
's getCriterion()
method is called.
optionDataSource
, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
optionDataSource
is set for this
ListGridField, criteria specified in this attribute will be passed to the dataSource when performing the fetch operation
to determine data-value to display-value mappings
optionDataSource
.
optionDataSource
of the combo box.
optionDataSource
and extracting the valueField
and displayField
in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource.
optionDataSource
.
valueField
and
displayField
in the loaded records,
to derive one valueMap entry per record loaded from the optionDataSource.
optionDataSource
, and this property is
not null, this will be passed to the datasource as RPCRequest
properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
optionDataSource
, and this property is
not null, this will be passed to the datasource as RPCRequest
properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
autoFetchDisplayMap
is set, this attribute
provides a way to customize the dataSource request issued to fetch the display map from
the option dataSource.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
optionDataSource
, this attribute may be set to specify an explicit operationId
when performing a fetch against the option dataSource to
pick up display value mapping.
autoFetchDisplayMap
is set, this attribute
provides a way to customize the operationId
passed to
dataSource.fetchData()
when retrieving the display map from the option dataSource.
optionDataSource
, where
autoFetchDisplayMap
is true, this property
will govern the textMatchStyle
attribute of the DSRequest
parameter passed
to DataSource.fetchData
when retrieving the remote data set to be
used as a basis for this field's valueMap.
baseStyle
for a cell
that is currently a selection origin for shifted incremental cell selection.
showOtherDays
is false.
Other...
item.
Other...
item.
outputField
.
process state
which this task writes outputs to.
process state
which this
task will write to.
outputFieldList
, by providing a Record.
"foo, bar, baz"
).
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 accommodate members.
Portlet
widths
overflow the width of the PortalLayout.
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
accommodate 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
accommodate members.
this.padding
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
this.padding
or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
facet.isTree
), id of this facetValue's parent
facetValue.
partialCommit
is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors.
partialCommit
is set to "prompt", the text to
display to the user in the confirmation dialog.
"summary"
.
snapTo
.
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
].
showTabPicker
is true, this property governs the size
of tab-picker button.
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
].
dateChooser
autoChild
displayed to allow the user to directly select dates.
DateChooser
for choosing an absolute date.
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, this attribute
specifies the name
applied to the picker icon
pickerIcon
.
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
, 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.
ComboBoxItem.setPickListFilterCriteriaFunction(FormItemCriteriaFunction)
SelectItem.setPickListFilterCriteriaFunction(FormItemCriteriaFunction)
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.
showDataPoints
is true,
and the user clicks on a point.
showDataPoints
is true,
and the user clicks on a point.
showDataPoints
is true and the mouse hovers
over a point.
showDataPoints
is true and the mouse hovers
over a point.
record components
, be pooled
per column or per record.
dropTypes
to be applied when dropping
Portlets
on this PortalLayout
, or when
dropping other components to be auto-wrapped in a Portlet
.
Portlets
on initialization.
prettyPrint
feature to enable indented, highly readable JSON
messages.
Portlet
in a column will be stretched to fill the
column's height, or left at its specified height.
DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.
preventHTTPCaching
on a per-operationType
basis.
Portlet
in a row will be stretched to fill the
row's width, or left at its specified width.
previous
toolbar button
sequence
or element
that is helpful for wizards.
Page.isRTL
is true.
Page.isRTL
is true.
printCellStyle
printable HTML
.
ResultSet
documentation
.
progressive loading mode
for this specific
request, overriding the OperationBinding- and DataSource-level settings.
progressively
.
progressively
.
prompt
for the header).
showHover
is true.
prompt
for the header).
showHover
is true.
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).
radioOperatorForm
.
#setCanEdit,canEdit false
and displayed in an editor component such as a DynamicForm.
showRecordComponents
is true, this
attribute may be used to specify a standard height for record components.
component-pooling
to employ for recordComponents
.
showRecordComponents
is true, how should
the component appear within the cell.
listGrid.expansionMode
is "related".
recordName
.
ListGrid.setData(ListGridRecord[])
type:"summary"
),
this attribute specifies a custom base style to apply to cells in the summary field
"summary"
.
"summary"
.
recordXPath
.
xmlRecordXPath
or jsonRecordXPath
is used based on
the dataFormat
setting.
marked for removal
.
canRemoveRecords
is enabled.
remove field
.
canRemoveRecords
is enabled, default icon to
show in the auto-generated field that allows removing records.
remove icons
for this
ListGrid.
id field value
as existing nodes, the existing nodes are removed when
the new nodes are added.
DSRequest
s made by this DataSource.
DSRequest
created for this operation.
DataSourceField
,
enabling both client and server side validation.
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.
canDragResize
, restricts
resizes to only certain edges or corners.
#setResizeFrom(EdgeName)
instead.
"resize"
control
knobs
, this attribute
specifies which sides / edges should show knobs.
RTL mode
, should cell alignments specified cellAlign
be reversed (so an align:"right"
field will have content aligned on the left and vice versa)?
Icon
for the rightButton
rightButtonIcon
rightButtonIcon
.
Title
for the rightButton
rightButtonTitle
rightButtonTitle
showMenuOnRollOver
is true, this is the
delay in milliseconds before the menu is automatically hidden following mouseOut.
showRollover
is true and
showRollOverCanvas
is true.
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.
ids
for facets that will appear to the left of the
body.
baseStyle
for the buttons in this grid's row headers.
com.smartgwt.client.grid.GridRenderer
component.
PortalLayout
,
then the height will be used when creating the new row.
PortalLayout
,
then the height will be used when creating the new row.
showRowNumbers
is true.
rowNumberField
.
RibbonBar
, the number of rows this button should consume.
useRowSpanStyling
is enabled.
dataSource
, this property can
be set to true
to prevent the grid from attempting to save / retrieve data from the server.
true
, when the user hits the Enter key while focused in a text-item in this form, we automatically
submit the form to the server using the DynamicForm.submit
method.
saveOnEnter
is true.
saveOnEnter
is true on the parent form.
saveOnEnter
is true.
saveOnEnter
is true.
FilterBuilder.search
method.
DSOperationType
to be performed when DynamicForm.saveData
is called.
DSOperationType
to be performed when DynamicForm.saveData
is called.
dataSource
, where
saveLocally
is false, this attribute may be used to
specify standard DSRequest properties to apply to all save operations performed by this grid (whether triggered by user
interaction, or explicit saveEdits or saveAllEdits call).
DynamicForm.submit
actions when called (typically from a SubmitItem
).
showTabScroller
is true, this property governs the
size of scroller buttons.
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition
set to "top" or "bottom"].
tab scroller buttons
, and
symmetricScroller
is false, this property governs
the base URL for the tab bar back and forward scroller button images.
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition
set to "left" or "right"].
workday hours
to be sized to
fill the available space in the day view and week view, and automatically scrolls these views to the start of the
workday when the calendar is first displayed and whenever the user switches to a new day or week.
TimeUnit
is "second".
TimeUnit
is "second".
SectionItem
s], this attribute
controls whether multiple sections can be expanded at once.
Gauge.getDefaultFillColor
to initialize the fill color of
new sectors.
sectorIndex
.
TreeGrid.getSelectedPaths
.
ListGrid.getSelectedState
.
multi-sort
grid) in the selected state.
showSelectionCanvas
is true.
useTextField
is true, falls through to
standard FormItem.setSelectionRange
implementation on this items freeform text entry field.
showSelectionCanvas
is true.
TextItem
, TextAreaItem
) is
given focus programmatically (see DynamicForm.focusInItem
), 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.
separateFolders
on the data for this treeGrid.
members
.
Other...
item in the drop down list.
Other...
value.
serverType:"sql"
with a field of
type "sequence", the name of the SQL sequence that should be used when inserting new records into this table.
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.
callback
as data
.
DateUtil.setShortDateDisplayFormatter(DateDisplayFormatter)
.
DateUtil.setShortDatetimeDisplayFormatter(DateDisplayFormatter)
.
ListGrid
or
TreeGrid
.
form.getValues()
?
DynamicForm.getValuesAsCriteria
is called, for the
criterion to be included in the returned AdvancedCriteria object
form.getValues()
?
DynamicForm.getValuesAsCriteria
is called, for the
criterion to be included in the returned AdvancedCriteria object
separator rows
in between.
separatorRows
in between.
separatorRows
in between.
true
this grid will create and show per-row backgroundComponents as detailed here
.
pickerIcon
.
showChooserFiscalYearPicker
.
Window.closeClick
.
closeConfirmationMessage
will be
displayed before portlets are closed
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.
showColumnMenus
and updates existing columns to reflect the new setting.
component.fields
.
DynamicForm
will set both showComplexFields
and
showComplexFieldsRecursively
on any nested component used for showing/editing a complex field.
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder.
customIconProperty
), show open state images when the
folder is opened.
customIconProperty
), show open state images when the
folder is opened.
dateChooser
is displayed.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
detail:true
when a DataBoundComponent is
given a DataSource but no component.fields
.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
detail:true
from this component's DataSource
.
detail:true
in the DataSource.
detail:true
when a DataBoundComponent is given a DataSource but no
component.fields
.
showDisabled
selectionAppearance
:"checkbox" is set on the treegrid, and a node can't be selected?
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.
showGrip
is true, this property determines whether to show
the 'Down' state on the grip image when the user mousedown's on this widget.
"target"
, should we show a shadow behind the canvas
during the drag.
icon
), this
property allows the developer to specify on a per-node basis whether a drop state icon should be displayed when the
user drop-hovers over this folder.node.showDropIcon
to true to show the drop state icon, or false
to suppress this.showCustomIconDrop
for this node.
EdgedCanvas
should be used to show image-based edges around this
component.
emptyMessage
when there is no data to
display?
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
showErrorIcons
, showErrorText
, and showErrorStyle
control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error).
canFilter:false
fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus.
showFocused
is true for this widget, should the
"over"
state be used to indicate the widget as focused.
showFocused
property.
showPickerIcon
is true for this item,
should the picker icon show a focused image when the form item has focus?
showFocused
, showFocusedIcons
), this property governs whether
the focused state should be shown when the item as a whole receives focus or just if the icon receives focus.
showConnectors
is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree.
timeUnitOption
we will show only past
options [for example "N weeks ago"].
showGridSummary
is true, should this field show
a summary value.
grouping
, setting this
property will cause the grid to render an extra row at the end of each group when grouped, containing summary
information for the fields.
showGroupSummary
is true, should this field
show a summary value in a summary row when the grid is grouped? If unset, this field will show a summary value in the
summary row if an explicit summaryFunction
is
specified or if a default summary function
is
defined for the specified field type.
grouped
, and showGroupSummary
is true, setting this property causes
field summary values for each group to be displayed directly in the group header node, rather than showing up at the
bottom of each expanded group.
ToolStripGroups
in
this ToolStrip show their header control.
grouped
and showGroupSummaryInHeader
is true, instead of
group header nodes showing up with a single cell value spanning the full set of columns, summaries for each field will
show up in the appropriate columns of the header node.
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.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the FormulaBuilder or
SummaryBuilder.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the hilite editor
.
headerSpans
, should field
titles be prefixed with the titles of the headerSpans in which they are contained when using the multi-sort editor.
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?
iconField
.
icons
for
this item.
leftButton
leftButton
.
fields
from another DataSource
(via inheritsFrom
), indicates that only the fields listed in
this DataSource should be shown.
showMaximizeButton
to show / hide the maximizeButton
menu-icon
which fires the menuIconClicked
notification method when clicked.
menu
when clicked.
moreTabCount
be shown on a "more"
tab?
moreTabCount
be shown on a "more"
tab?
showHeaders
is also set, each column's
header will show a count of the number of nodes in that column
icon
), this
property allows the developer to specify on a per-node basis whether an open state icon should be displayed when the
folder is open.
open
folders than closed folders.
open
folders than closed folders.
valueMap
, by default we show the valueMap
options in the pickList for the item.
valueMap
by default we show the
valueMap options in the pickList for the item.
valueMap
, by default we show the valueMap
options in the pickList for the item.
Over
state?
overCanvas
on user rollover.
showOver
property.
edges
.
edges
, setting
this attribute to true
will set the paneContainer to show customEdges
for the three sides opposing the tabBarPosition.
timeUnitOption
we will show only future
options [for example "N weeks from now"].
icon
for this form item.
Alt+Arrow Down
key combination?
showPrompt
if it's unset.
'recordComponents'
in cells,
rather than just in records.
Layout
, whether a resizeBar
should be shown after this member in the layout, to allow it to be resized.
rightButton
rightButton
.
showRollOver
is true, this property provides an
option to show roll over styling with the rollOverCanvas
and rollUnderCanvas
rather than
using css styling.
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.
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
includes the root
node.
selectionType
is set to "single"
,
setting this property to true means selection will be displayed to the user with the selectionCanvas
and selectionUnderCanvas
rather than using css styling.
appearance
.
showShadow
.
labelAsTitle
.
false
to explicitly suppress display of the field title in the column header
button for the field.
showButtonTitle
instead.
title
will be displayed
for this component.title
will be displayed
for this component.title
will be displayed
for this component.title
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.
valueTitle
as a label on the
value axis.
valueTitle
as a label on this
extra value axis.
valueIcons
is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying
showFiscalYearChooser
.
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
.
frozen
fields, and a
horizontal scrollbar is visible at the bottom of the liquid columns, should an equivalent scrollbar gap be left visible
below the frozen columns?true
any backgroundColor or border applied to the
ListGrid will show up below the bottom row of the frozen column(s).
record[this.singleCellValueProperty]
is set for some record, the record will be displayed as a single
cell spanning every column in the grid, with contents set to the value of
record[this.singleCellValueProperty]
.
skinDir
.
skinDir
.
skinDir
.
skinDir
.
snapTo
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element.
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
masterElement
(if specified), or its parentElement
.
displayField
configured, should client-side sorting be performed on the display field
value? Unless explicitly set to false
the display field value is used.
valueMap
is set, and the grid is sorted
by this field, should the data be sorted by the underlying
data value or the mapped display value.
FacetValueMap
of facet values representing a set of facetValues by which the
cubeGrid data is sorted.
headerSpans
, and showHeaderSpanTitlesInSortEditor
is true,
this string will be inserted between the headerSpan title(s) and the field title in the field chooser grid on the
multi-sort editor
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to sort a field in ascending order.
headerContextMenu
for this
grid, this attribute will be shown as the menu item title to sort a field in descending order.
fieldPicker
items be sorted
alphabetically in the drop down list.
separateFolders
is true, should folders be displayed
above or below leaves? When set to true
folders will appear above leaves when the
sortDirection
applied to the tree is ASCENDING
sortFoldersBeforeLeaves
on the data for this treeGrid.
SortSpecifier
s) to
match the ListGridSortState object passed in.ListGrid.getSortState
.
WSDL web service
, setting
this flag means the DataSource doesn't actually attempt to contact the server but generates a sample response instead,
based on the XML Schema of the response message embedded in the WSDL.
ChartType
is "Column" then the metric settings may include a setting for stacked
.
memberOverlap
, controls
the z-stacking order of members.
timeline view
.
CalendarEvent
.
CalendarEvent
.
sequence
or an element
which should be the starting point of the process.
status
, except DSResponses have additional error
codes, such as validation failure
.
stretching column widths
, should
we stretch all column widths proportionally, or just stretch the columns that need extra width?
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an summary function registered via com.smartgwt.client.data.SimpleType#registerSummaryFunction()
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true, this attribute can be used to
specify an explicit SummaryFunction
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true,
this method can be used to
specify a SummaryFunctionType
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true,
this method can be used to
specify the name of a summary function registered via com.smartgwt.client.data.SimpleType#registerSummaryFunction()
for calculating the summary value to display.
showGridSummary
or showGroupSummary
is true,
this method can be used to
specify a SummaryFunction
for calculating the summary value to display.
showGridSummary
is true, and a summaryRowDataSource
is specified this property may
be used to specify fetch criteria to apply when retrieving summary data to show in the summary row.
showGridSummary
is true, by default summary
values are calculated on the client based on the current data-set for the grid (see ListGrid.getGridSummary
and ListGrid.getGridSummaryFunction
).
ListGrid.setShowGridSummary(Boolean)
is true, and a
${isc.DocUtils.linkForRef('listGrid.summaryDataSource')} is specified this property may be used to customize the fetch
request used when retrieving summary data to show in the summary row.
summary row autoChild
.
baseStyle
for the summaryRow
headerTitle
attribute to show a different title in the
column header button than the title used elsewhere.
summaryRow
.
showGridSummary
or showGroupSummary
is true and the summaryFunction
is set to "title"
, this
attribute may be set to a string to display in the group and/or grid summary.
evalResult
is set, setting this property to true causes
autoDraw
to be set to false for the duration of the result
evaluation - which is generally what you want if you're returning new components from the server.
DynamicForm.saveData
on a form or
valuesManager, by default if the server returns an error code, any callback passed into saveData() will not be fired.
ValuesManager.saveData
on a form or
valuesManager, by default if the server returns an error code, any callback passed into saveData() will not be fired.
valueIcons
is set, this property may be set to
prevent the value icons from showing up next to the form items value
show edges
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides).
tab picker button
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition
based on the pickerButtonSrc
property for this tabSet.
tab scroller buttons
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition
based on the scrollerSrc
property for this tabSet.
tabBar
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.
textField
.
extra value axes
.
SimpleTile
, CSS style for each value shown within a
tile.
Calendar.setTimeFormatter(TimeDisplayFormat)
instead.
TimeDisplayFormat
for type:"time"
field values displayed in this form.
timeFormatter
or the system-side
timelineGranularity
each
cell represents.
Canvas.setPrompt(String)
"Cancel"
by default.
"Submit"
by default.
menu for picking visible fields
.
menu for picking visible fields
.
Tree
.
titleEditor
.
title label
in this group.
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.
toDate
is supplied.
showToolbar
, if shown.
Canvas.setPrompt(String)
position
property).
position
property).
group rectangle
in pixels
relative to the DrawPane.
topOperator
for
this FilterBuilder.
topOperatorForm
.
to
part of the range.
treeField: true
will display the Tree
.
OperatorIds
valid for a given FieldType.
headerContextMenu
for this
grid and this.canFreezeFields
is true, this string
will be shown as the title for the menu item to unfreeze a currently frozen field.
headerContextMenu
for this
grid, and this.isGrouped
is true, this attribute will be
shown as the title for the menu item to ungroup the grid.
canRemoveRecords
is enabled, this icon will
be shown in the auto generated field fro removing records if the record has been marked as removed via ListGrid.markRecordRemoved
.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set? This attribute will be passed to DataSource#getUpdatedData
as the useDataFromRequest
parameter.
data
is unset, should we integrate the submitted data values (from the
request) into our data-set?
BatchUploader
to map a field in an upload file to this dataSourceField.
uploadFormFields
before they are stored in the
HttpSession on the server.
FileItem
field where the user enters a
filename to upload
operationId
for the "add" operation used to add new
records to the uploadDataSource
.
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.
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.
dataColors
but specify chart-specific gradients based on the primary data color per chart type.
backMask
in Internet Explorer
versions predating Internet Explorer 9.
canSelectCells
is true
fiscal year chooser
, should
firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday,
the calendar will display Tuesday to Monday from left to right.
useFlatFields
, but applies to all DataBound
components that bind to this DataSource.
useFlatFields
is set for a request to be sent to a WSDL web service, when
creating the input XML message to send to the web service, properties in
request.data
will be used as the values for XML elements of the same
name, at
any level of nesting.
useFlatFields
on an operationBinding is equivalent to setting useFlatFields
on all DataSource requests with the same operationType
as this operationBinding
.
useFlatFields
is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data
will be used as the values for XML elements of the same name, at any level of nesting.
useFlatFields
flag causes all simple type fields anywhere in a nested
set of DataSources to be exposed as a flat list for form binding.
useFlatFields
XML serialization behavior to be
used for all soap headers in the request.
ID
be applied to the generated
SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID will behave as a synonym
for SectionStackSection.name.
useHttpProxy
, but serves as a default for this
DataSource that may be overridden by individual operationBindings.
HttpProxy
servlet to send requests described
by this operationBinding.
displayField
.
useTextField
is not false
this
property determines if an input mask should be used.
timeFormatter
.
browser-based
offline storage
, and then use those stored responses at a later time if we are offline (ie, the application cannot
connect to the server).
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.
saveLocally
is specified, but this grid is bound to
a DataSource which includes remote field validators, by default edits will be saved synchronously and these validators
will not be executed.true
to ensure these remote validators are called when
saving edits in saveLocally mode.
ListGrid.getRowSpan
has been overriden to introduce spanning
cells, and spanning is largest on the left and smaller as cells go to the right.
ImgTab
tabs?
client-only
or cacheAllData
DataSource to create a second DataSource to perform
it's one-time fetch.
true
when getCriteria
is called, the item will validate the
"to" and "from" fields and return null if either field fails validation.
validators
for this field will
be run whenever the value of the field is changed.
ValidatorType
of "hasRelatedRecord" to every field on this dataSource that has a foreignKey
defined.
Validator
objects for this field.
drawnValue
represents.
type
to be "header", the
value of this attribute specifies the header text.
multiple value axes
.
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.
valueField
of the combo box.
displayField
values from an optionDataSource
, this property denotes
the the field to use as the underlying data value in records from the optionDataSource.name
of this form item.
displayField
values from an optionDataSource
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name
of this form item.
optionDataSource
field used to
retrieve the stored values that are to be mapped to the display values (specified by displayField
).
FormItemValueFormatter
, if provided, is evaluated to get the
display value to show for this form items underlying data value.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible.
valueIcons
is specified, use this property to
specify a height for the value icon written out.
valueIconLeftPadding
valueIconRightPadding
valueIcons
is specified, this property may be
used to specify both the width and height of the icon written out.
valueIcons
is specified, use this property to
specify a width for the value icon written out.
valueMap
.
valueMap
.
ListGrid.setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap
methods which allow further
customization of the valueMap displayed while the field is in edit mode.
ListGrid.setEditorValueMap(java.lang.String, java.util.LinkedHashMap)
and com.smartgwt.client.widgets.grid.ListGrid#getEditorValueMap
methods which allow further
customization of the valueMap displayed while the field is in edit mode.
canEdit
, canEdit
), editors displayed for this
field will pick up their valueMap either from this value or from editorValueMap
.
canEdit
, canEdit
), editors displayed for this
field will pick up their valueMap either from this value or from editorValueMap
.
ValuesManager
for managing values displayed in this component.
Tree
of options from which the user can select.
this.vertical
is true.
ListGrid.getViewState
.
vertical
is true, and src
is unset.
vertical
is true and src
is unset.
vertical
is true and src
is unset.
canRemoveRecords
is true, when the user clicks
the remove icon for some record, should we show a warning message (defined as warnOnRemovalMessage
) and allow the user to cancel
removal?
canRemoveRecords
is true and warnOnRemoval
is true.
displayField
specified and has no
optionDataSource
, this field will display the
value from the displayField
of each record by default (for more on this behavior see optionDataSource
).
week-based
HeaderLevel
s in this timeline.
TimeUnit
is "week".
TimeUnit
is "week".
showNavigation
is true and NavigationMode
is set to "wholeRecord".
group rectangle
in pixels relative to
the DrawPane.
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 String.
showWorkday
is true
showWorkday
:true,
workdayStart
and workdayEnd
specify the time of day when the workday starts and ends,
specified as a String acceptable to String.
DataSource.xmlSerialize
should serialize this
value as an XML attribute.
recordXPath
and
valueXPath
XPath expressions.
dataFormat
is "xml", xmlNamespaces
configures the set of namespace prefixes that are added to the document element of the XML message sent to the server.
resultType
parameter of WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)
, if resultType is an XPath.
recordXPath
mapping to the data node of XML returned by the server.
TimeUnit
is "year".
yearSelector
.
TimeUnit
is "year".
dismissOnEscape
is set, just
return it.
optionDataSource
, should we perform a fetch against that dataSource to find the record that matches this field's value?
FormItemCriterionGetter
's getCriterion()
method enforce a search for an exact match against the chosen value?
DynamicForm.setErrors(java.util.Map, boolean)
or
DynamicForm.validate(boolean)
.
ValuesManager.handleHiddenValidationErrors
to allow custom handling of hidden errors.
icons
array, if it is not already visible.
FormItem.show
menu
.
showRecordComponents
is true, return
false from this method to prevent showRecordComponent behavior for the passed record.
DynamicForm.setValues
or FormItem.setValue
and may be overridden by CanvasItems
intended to support displaying data values to update the embedded Canvas to reflect the value passed in.
TileGrid
to render each tile.SimpleType
.SimpleType
.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.fields
.
server.properties
startElement
.
RelativeDate.TODAY
)
RelativeDate.TOMORROW
)
RelativeDate.YESTERDAY
)
ListGrid API
is not supported by the
TreeGrid since adding a new tree node arbitrarily at the end of the tree is usually not useful.
state
to other fields, or
apply hardcoded values to state
via value
.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.AdvancedCriteria
?
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
.
Canvas.showClickMask
).
Process
and for all Task types that can
be involved in a Process, such as a ServiceTask
.<TEXTAREA>
object)DataSource.recordsAsText
.DataSource.recordsFromText
.TextImportSettings
.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.DateDisplayFormatter
insteadDateDisplayFormatter
insteadCalendar
that configures the Calendar
with settings typical for a standalone timeline view: no other tabs (week, month, day) are shown and the control bar is
hidden by default.RelativeDateItem
and
Calendar
widgets.[H]H:MM:SS
.
20051104T111001Z
4/11/2005
4/11/2005 11:03
2005/11/4
2005/11/4 11:03
icon buttons
, radio button groups
, menus
, comboBoxes
, spacers
, status displays
and drop-down selects
.tool-strips
.IMenuButton
with an appearance appropriate for a ToolStrip menu button.HH:MM:SS
.
HH:MM:SS am|pm
.
top-level operator
of a FilterBuilder.2005-11-04 11:09:15
[H]H:MM
.15:25
HH:MM
.15:25
, 03:16
HH:MM am|pm
.03:25 pm
[H]H:MM am|pm
.3:25 pm
[H]H:MM:SS am|pm
.
11/4/2005
11/4/2005 11:03
DataSource.transformRequest(DSRequest)
.
dataURL
.
DataSource.transformResponse(DSResponse, DSRequest, Object)
Tree
class, which manipulates hierarchical data sets
the TreeGrid widget class, which extends the ListGrid class to visually present tree data in an
expandable/collapsible format.TreeGrid
.StringUtil.asHTML(String)
.
ListGrid.markRecordRemoved
.
Page.registerKey(String, KeyCallback)
method.
Canvas.handleHover
), this method can be called to update the contents of the hover.
Canvas.handleHover
), this method can be called to update the contents of the hover.
showRecordComponents
is true, this method
is called for a row/cell that has already been rendered.
textBoxStyle
).
canAddFormulaFields
behavior.errors
validation errors or a status
code of 0.
errors
validation errors or a status
code of 0.
Validator
- see list below.Slider.valueChanged
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).
FilterBuilder
class to indicate the role of a particular
value-field form item within a filter clause.DynamicForm.rememberValues
method.
DynamicForm.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.
Portlet
, or other component, can be dropped onto
this PortalLayout
(other components would be auto-wrapped in a Portlet
).
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match (from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed a certain set of criteria.
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match (from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed a certain set of criteria.
"scriptInclude"
transport
for cross-domain calls to JSON services, such as those provided by Yahoo!.state
.
|
|||||||||
PREV NEXT | FRAMES NO FRAMES |