# All Classes and Interfaces

Class
Description
AbstractSmartEvent<H extends EventHandler>
Accessibility
Accessibility / Section 508 compliance
AceAnchor
Internal use only.
AceCompleter
Internal use only.
AceCompleterCompletionsCallback
AceCompletionResult
Internal use only.
AceDocument
Internal use only.
AceEditor
Internal use only.
AceEditorChangedEvent
AceEditorChangedHandler
AceEditorLogicalStructure
AceEditSession
Internal use only.
AceMarker
Internal use only.
AcePosition
Internal use only.
AceRange
Internal use only.
AceRenderer
Internal use only.
AceUndoManager
Internal use only.
ActiveXControl
ISC Abstraction for ActiveX controls
ActiveXControlLogicalStructure
AdaptHeightByCustomizer
AdaptiveMenu
A menu that can either show its menu options inline, or show them via a drop-down, depending on available space in the surrounding `Layout` or `ToolStrip`.
AdaptiveMenuLogicalStructure
AdaptWidthByCustomizer
AddScreenTask
Adds a new screen instance to a Layout, as a new Tab in a TabSet or as a new Section in a SectionStack.
AddTabClickedEvent
Deprecated.
AddTabClickedHandler
Deprecated.
AddTabClickEvent
AddTabClickHandler
AdminConsole
Admin Console
AdminSearches
Policy for choosing between admin searches fetched from the DataSource vs.
AdvancedCriteria
AdvancedCriteria is a format for representing search criteria which may include operators on field values such as "less than", or may include sub-clauses such as several criteria applied to fields joined by an "OR" operator.
AdvancedCriteria
AdvancedCriteria is a format for representing search criteria which may include operators on field values such as "less than", or may include sub-clauses such as several criteria applied to fields joined by an "OR" operator.
AdvancedCriterionSubquery
A specialized subclass of `DSRequest` that you use to declare the properties of a subquery (a `fieldQuery` or `valueQuery`) to be used in `AdvancedCriteria`.
AdvancedCriterionSubquery
A specialized subclass of `DSRequest` that you use to declare the properties of a subquery (a `fieldQuery` or `valueQuery`) to be used in `AdvancedCriteria`.
AdvancedFilter
Advanced Filtering
AdvancedHiliteEditor
A widget for editing a single, advanced `hilite rule` for use by `dataBoundComponents`.
AdvancedHiliteEditorLogicalStructure
Ai
The following APIs are all related to Ai.
AI
Provides class methods for enabling and disabling the use of AI technology, registering and unregistering `AI engines`, and performing high-level operations using installed AI engines.
AIContentType
AIContext
Context object for an AI process.
AIEngine
Provides access to a particular generative AI model.
AIFieldRequest
Settings that configure requests to AI to generate the values for a field.
AIHoverRequest
Settings that configure requests to AI to generate the contents of hovers.
AIMessage
An individual message in the list of `AIRequest.messages` of an AI request.
AIMessageSource
AIMessageWithSource
AIProgressCallback
AIProgressMessage
A message relating to progress made in an ongoing build-via-AI operation.
AIProgressMessageCategory
AIRequest
Represents a request to AI for a response.
AIResponse
Represents a response from AI.
AIResponseCallback
AIResponseErrorType
For an `AIResponse` of `type` ERROR, the type of error, if known.
AIServiceMode
The mode for how AI should respond to AI-powered component view requests, such as filering, sorting, and hiliting via AI.
AISortProgressDialog
Dialog informing user of the progress when doing an AI sort.
AISortProgressDialogLogicalStructure
AIWindow
Window subclass used by the "Filter via AI…" and "Hilite via AI…" `ListGrid` header context menu items to allow the user to filter or hilite by a natural language description of a filter or hilite, respectively.
AIWindowLogicalStructure
Alignment
AllowedOperations
The following APIs are all related to AllowedOperations.
Ancestry
Parent/child relationships
AnimateShowEffect
Configuration object for effect to apply during an animated show or hide.
Animation
The following APIs are all related to Animation.
Animation
AnimationAcceleration
Acceleration effect for animations.
AnimationCallback
AnimationEffect
String specifying effect to apply during an animated show or hide.
AnimationLayoutMode
During a `size animation`.
AnnotationMetaBeanFactoryGenerator
AnswerEngine
Answer Engine
Appearance
Properties defining an object's appearance
ApplicationDeclaration
Application Declaration Files
ApplyClickEvent
ApplyClickEvent
ApplyClickHandler
ApplyClickHandler
ArrayValueType<ValueType>
ArrowKeyEditAction
What to do if the user hits Up or Down arrow key while editing a cell.
ArrowStyle
Supported styles for arrowheads.
AskDataQuestionResultCallback
AskForValueTask
Ask the user to input a value.
AsyncDataBoundOperationContext
Context for an asynchronous data-bound operation.
AsyncDataBoundOperationParams
Parameters to an asynchronous data-bound operation.
AsyncMultipleValuesGenerationResult
The result of an asynchronous operation to generate multiple values.
AsyncMultipleValuesGenerationResultCallback
AsyncOperationContext
Context for an asynchronous operation.
AsyncOperationParams
Parameters to an asynchronous operation.
AsyncOperationResult
An object containing information about the result of an asynchronous operation.
AsyncOperationResultType
The type of result of an asynchronous operation.
AsyncSingleValueGenerationResult
The result of an asynchronous operation to generate a value.
AsyncSingleValueGenerationResultCallback
AsyncUtil
Contains utilities and constants to support asynchronous code.
AsyncValidationReplyEvent
AsyncValidationReplyEvent
AsyncValidationReplyHandler
AsyncValidationReplyHandler
Auth
The following APIs are all related to Auth.
Authentication
The Authentication or Auth class represents a convenient, standard place to keep information about the currently logged in user and their assigned user roles.
AutoChild
An autoChild is an automatically generated subcomponent that a component creates to handle part of its presentation or functionality.
AutoChildShortcut
A string with the format "autoChild:autoChildName" passed as a `Tab.pane` or `section item` instead of an actual `Canvas` or ID.
AutoChildUsage
Using AutoChildren
AutoComplete
AutoComplete behavior for `FormItems`.
Autofit
Possible values to change the behavior of how data will fill the ListGrid.
AutoFitData
The following APIs are all related to AutoFitData.
AutoFitEvent
Event on a listGrid header to trigger auto-fit of the listgrid field.
AutoFitFields
The following APIs are all related to AutoFitFields.
AutoFitIconFieldType
How should fields of `type:"icon"` be sized by default?
AutoFitTextAreaItem
Class for editable multi-line text areas (uses HTML `<TEXTAREA>` object) automatically expands to accommodate its content
AutoFitWidthApproach
How should field width be determined when `ListGridField.autoFitWidth` is true?
AutomatedTesting
Automated Testing
AutoScrollDataApproach
What should drive the automatic expansion of the chart?
AutoSelectionModel
Selection model for `CubeGrid` indicating which cells in the body should be selected when row or column headers are selected.
AutoTest
The following APIs are all related to AutoTest.
AutoTest
Standalone class providing a general interface for integration with Automated Testing Tools
AutoTestLocator
An AutoTestLocator is a string generated by the `AutoTest` class to reliably identify an interactive element in a Smart GWT application.
Axis
An axis or "side" of a table.
BackgroundClickEvent
BackgroundClickHandler
BackgroundDownload
Background Download
BackgroundMouseDownEvent
BackgroundMouseDownHandler
BackgroundMouseUpEvent
BackgroundMouseUpHandler
BackgroundRepeat
BalsamiqImport
Mockup Importer
BarChart
The following APIs are all related to BarChart.
BaseClass
BaseLine
The baseLine is StretchImg that is placed along the edge of the TabBar that borders on the pane, occluding the pane's actual border but matching it exactly.
BaseWidget
Base class for `Canvas` and `DrawItem`.
BaseWidgetLogicalStructure
Basics
The following APIs are all related to Basics.
BatchUploader
The BatchUploader handles the upload, validation, review and saving of a dataset expressed in CSV or other upload formats.
BatchUploader
Deprecated.
This class has been moved to the `com.smartgwt.client.widgets` package.
BatchUploader
Deprecated.
This class has been moved to the `com.smartgwt.client.widgets` package.
BatchUploaderLogicalStructure
BeanClass
BeanFactory<BeanClass>
Utility class for creating objects and setting properties at run-time via reflection-like mechanisms.
BeanFactory.AnnotationMetaFactory
BeanFactory.CanvasMetaFactory
Interface used to trigger the generation and registration of reflection metadata for `Canvas` and all its subclasses found in the classpath (including your custom subclasses).
BeanFactory.FormItemMetaFactory
Interface used to trigger the generation and registration of reflection metadata for `FormItem` and all its subclasses found in the classpath (including your custom subclasses).
BeanFactory.FrameworkClass
BeanFactory.Generate
Annotation which will trigger the generation of BeanFactories.
BeanFactory.MetaFactory
An interface which you can extend in order to register classes with the `BeanFactory` reflection mechanism.
BeanFactory.ScClassName
BeanFactoryForBaseClass<BeanClass extends BaseClass>
BeanFactoryForBaseWidget<BeanClass extends BaseWidget>
BeanFactoryForDataClass<BeanClass extends DataClass>
BeanMethod<BeanClass,ValueType>
BeanMethod
BeanProperty<BeanClass>
BeanProperty
BeanProperty.NoSetterException
BeanProperty1Getter<BeanClass>
BeanProperty1Getter1Setter<BeanClass>
BeanProperty1Setter<BeanClass>
BeanPropertyMultiple<BeanClass>
BeanValueType<ValueType>
Class with static methods that help with various reflection-like tasks with respect to values used by `BeanFactories` (that is, the return types of getters, and the parameter types of setters).
BeanValueType
BeanValueType.Convertability
An enum used to indicate how well a BeanValueType can handle a conversion.
BeanValueType.MetaFactory
Interface used to trigger the generation and registration of reflection metadata for argument types.
BeanValueTypeFactoryGenerator
BeforeCommitEvent
BeforeCommitHandler
BinaryFields
Binary Fields
BkgndRepeat
BlurbItem
FormItem intended for inserting blurbs of instructional HTML into DynamicForms.
BlurEvent
BlurHandler
BodyKeyPressEvent
BodyKeyPressHandler
BooleanCallback
BooleanItem
Boolean form item, implemented with customizable checkbox images
BooleanValueType
Browser
The `Browser` class contains various class attributes that indicate basic properties of the browser and whether certain features are enabled.
BrowserEvent<H extends EventHandler>
BrowserPlugin
Container for a Browser Plugin.
BrowserPluginLogicalStructure
BrowserSupport
Supported Browsers
BrowserWindowSettings
Allows specifying additional browser window settings when calling the underlying JavaScript or OpenFin call to create the child window in `MultiWindow.open()`.
BrowserZoom
Native Browser Zoom Support
BuildDataBoundUIViaAIContext
BuildHilitesContext
BuildHilitesResponse
Represents a response from AI to a request to build one or more `Hilite` objects.
BuildUIViaAIContext
Context for an ongoing build-UI-via-AI operation.
BuildUIViaAIProgressDialog
BuildUIViaAIProgressDialogLogicalStructure
BuildUIViaAIValidationType
BuildViaAIContext
BuildViaAIProgressDialog
A dialog that can be used to inform the user of progress made on a build-via-AI process.
BuildViaAIProgressDialogLogicalStructure
BuildViaAIResponse
Base class for a representation of a response to a high-level request to AI to build something.
BuiltinGroupingModes
`SimpleTypes` support a mechanism for arranging values into groups.
Button
The following APIs are all related to Button.
Button
The Button widget class implements interactive, style-based button widgets.
ButtonClickEvent
ButtonClickHandler
ButtonIcon
Button Icon
ButtonItem
FormItem for adding a Button to a form.
ButtonLogicalStructure
Buttons
The following APIs are all related to Buttons.
CacheSync
The following APIs are all related to CacheSync.
CacheSynchronization
Automatic Cache Synchronization
CacheSyncStrategy
Indicates the strategy to be used for `automatic cache synchronization`, for a given `DataSource`, `OperationBinding` or `DSRequest`.
CacheSyncTiming
Indicates the timing strategy to be used for `automatic cache synchronization`, for a given `DataSource`, `OperationBinding` or `DSRequest`.
Caching
Caching
CalculatedDataSourceFields
The following APIs are all related to CalculatedDataSourceFields.
Calendar
The Calendar component provides several different ways for a user to view and edit a set of events.
CalendarEvent
The following APIs are all related to CalendarEvent.
CalendarEvent
A type of `Record` which represents an event to occur at a specific time, displayed within the calendar.
CalendarEventAdded
CalendarEventChangedEvent
CalendarEventClick
CalendarEventRemoveClick
CalendarEventRemoved
CalendarLogicalStructure
CalendarSaveScenario
Indicates how a given Calendar Save was initiated - values are dialog, editor and mouse.
CalendarView
CalendarView is a base class, extended by the various views available in a `Calendar`.
CalendarViewLogicalStructure
Callback
A `Callback` is an arbitrary action to be fired - usually passed into a method to be fired asynchronously as a notificaction of some event.
The `callback` can be defined in the following formats: a function A string containing an expression to evaluate An object with the following properties:
- target: fire in the scope of this target - when the action fires, the target will be available as `this`.
- methodName: if specified we'll check for a method on the target object with this name.
`Callbacks` are fired via the Class.fireCallback() method, which allows named parameters to be passed into the callback at runtime.
CancelClickEvent
CancelClickEvent
CancelClickHandler
CancelClickHandler
CancelItem
Button that cancels any changes in the form, by calling `DynamicForm.cancelEditing` when clicked.
Cancellable
CancellationController
Provides a mechanism for canceling asynchronous operations.
CanEditChangedEvent
CanEditChangedHandler
CanPlayCallback
CanSelectRecordCustomizer
Called to determine whether a given record can be selected in a grid.
Canvas
Base class for all Smart GWT visual components (except `FormItems`).
CanvasBaseValueType<ValueType extends Canvas>
CanvasEditProxy
`EditProxy` that handles `Canvas` objects when editMode is enabled.
CanvasInitHandler
CanvasItem
FormItem which renders a Canvas inline in a DynamicForm instance.
CanvasLogicalStructure
CanvasMetaBeanFactoryGenerator
CellClickEvent
CellClickHandler
CellContextClickEvent
CellContextClickHandler
CellContextMenuItemsCustomizer
CellCSSTextCustomizer
Returns additional CSS to apply to a cell, on top of the grid's cell-styling
CellDoubleClickEvent
CellDoubleClickHandler
CellEditValueFormatter
CellEditValueParser
CellErrorIconHoverEvent
CellErrorIconHoverHandler
CellErrorIconOutEvent
CellErrorIconOutHandler
CellErrorIconOverEvent
CellErrorIconOverHandler
CellFormatter
Defines the HTML that's displayed in the cells of a `ListGridField` or entire `ListGrid`.
CellHoverCustomizer
Called to determine the hover text for a given cell in a CalendarView
CellHoverEvent
CellHoverHandler
CellMouseDownEvent
CellMouseDownHandler
CellMouseUpEvent
CellMouseUpHandler
CellOutEvent
CellOutHandler
CellOverEvent
CellOverHandler
CellRecord
A CellRecord represents the data for one cell of the body area.
CellRecordMode
When `canSelectCells` is true, whether `getSelection()` on a `DataBoundComponent` or individual `CellSelection` should return one record per selected cell, as with `CubeGrid`, or one record per row that has any selected cells, as with `ListGrid`.
CellSavedEvent
CellSavedHandler
CellSelection
Maintains a representation of selection over a 2-dimensional grid of objects.
Automatically created to manage cell-selection on `CubeGrid` widgets.
CellSelectionChangedEvent
CellSelectionChangedHandler
CellStyleHandler
CellStyleSuffixes
As with `stateful canvases`, grid cells support being styled to reflect the current state of the cell by generating a css styleName from the specified `baseStyle`, plus stateful suffixes.
CellStyling
The following APIs are all related to CellStyling.
CellValueHoverEvent
CellValueHoverFormatter
CellValueHoverHandler
ChangedEvent
ChangedEvent
ChangedEvent
ChangedHandler
ChangedHandler
ChangeEvent
ChangeEvent
ChangeHandler
ChangeHandler
ChangeHandling
The following APIs are all related to ChangeHandling.
CharacterCasing
ChartBackgroundDrawnEvent
ChartBackgroundDrawnHandler
ChartDrawnEvent
ChartDrawnHandler
ChartFeatures
The following APIs are all related to ChartFeatures.
ChartPointClickEvent
ChartPointClickHandler
ChartPointHoverCustomizer
ChartProperties
The following APIs are all related to ChartProperties.
ChartTitle
The following APIs are all related to ChartTitle.
ChartType
The following APIs are all related to ChartType.
ChartType
Known chart types.
CheckboxField
The following APIs are all related to CheckboxField.
CheckboxItem
Checkbox form item, implemented with customizable checkbox images.
CheckboxItemEditProxy
`EditProxy` that handles `CheckboxItem` when editMode is enabled.
ChildrenPropertyMode
when heuristically finding a property that appears to contain child objects, the ChildrenPropertyMode determines how to chose the property appears to contain child objects
CircleToCommand
Command to draw a segment of a specified circle.
ClearEvent
ClearHandler
ClickEvent
ClickEvent
ClickEvent
ClickHandler
ClickHandler
ClickHandler
ClickHandler
ClickMask
The following APIs are all related to ClickMask.
ClickMaskMode
Passed as a parameter to `Canvas.showClickMask()` to determine the masks behavior when clicked.
ClientData
The following APIs are all related to ClientData.
ClientDataIntegration
Client-side Data Integration
ClientOnlyDataSourceCallback
ClientOnlyDataSources
Client Only DataSources
ClientServerIntegration
Client-Server Integration
ClientUniquenessCheckCondition
For a validator of type `isUnique` in a component listing multiple records such as a ListGrid, can we use the component's fetched data set to check for uniqueness? Used by `Validator.checkComponentData`.
Clipping
The following APIs are all related to Clipping.
CloseClickEvent
CloseClickHandler
CloseClickHandler
CloseCommand
Command to close the current sub-path.
ClusterSizeMapper
CollapseSectionCallback
ColorChangedEvent
ColorChangedHandler
ColorItem
Form item for selecting a color via a pop-up `ColorPicker`.
ColorMapper
ColorPicker
The ColorPicker widget allows the user to select a color from anywhere in the color spectrum.
ColorPickerItem
Form item for selecting a color via a pop-up `ColorPicker`.
ColorPickerLogicalStructure
ColorPickerMode
ColorSelectedEvent
ColorSelectedHandler
ColorStop
An object containing properties that is used in Gradient types
ColumnTree
The Smart GWT system supports hierarchical data (also referred to as tree data due to its "branching" organization) with: the `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.
ColumnTreeLogicalStructure
ComboBoxFiltering
ComboBoxItem PickList Filtering
ComboBoxItem
The Combobox is a text input field which can show a list of options via a drop-down PickList.
ComboBoxItemCriteria
ComboBoxItem criteria
Communication
The following APIs are all related to Communication.
ComponentBinding
Component Binding
ComponentSchema
Component Schema
ComponentTask
Base class for tasks that target SmartGWT UI-specific operations.
ComponentXML
Component XML
CompoundFormItem_skinning
When skinning basic FormItems like SelectItem and TextItem, consider that compound form items like DateItem and ComboBox reuse simpler items like SelectItem and TextItem, so adding a border to SelectItem would also apply a border to each select item within DateItem.
To avoid such side-effects, if you want to add styling to all SelectItems used in your application, you can create an application-specific subclass like MySelectItem and apply properties there.
Compression
Compression
ConcurrentEdits
Handling concurrent edits in Smart GWT DataSources
ConfigUtil
ConnectorOrientation
Supported styles of connector orientations.
ConnectorStyle
Supported styles of connector styles.
Constant
The following APIs are all related to Constant.
Containment
Component Containment and Hierarchy
ContainsValidator
Determine whether a string value contains some substring specified via `substring`.
ContentLayoutPolicy
Policy controlling how the window will manage content within its body.
ContentLoadedEvent
ContentLoadedHandler
ContentLoading
The following APIs are all related to ContentLoading.
Contents
The following APIs are all related to Contents.
ContentsType
What type of content is being displayed within the `HTMLFlow`? This content may come from the `contentsURL` or be directly specified as `HTMLFlow.contents`.
ControlName
Names for the standard controls built into the RichTextEditor.
ConvertTo
This object contains all of the methods for converting from a JavaScriptObject to an array of specific SmartGWT class types.
Corner
The following APIs are all related to Corner.
CreateDashboardComponentDataQuestionStep
CreateDashboardComponentDataQuestionStepResult
CreateDashboardDataQuestionStep
CreateScreenSettings
Controls what class and instance substitutions, if any, are applied during a call to `RPCManager.createScreen()`.
CreateTileCustomizer
Criteria
Criteria for selecting only a matching set of records from a DataSource.
Criteria
Criteria for selecting only a matching set of records from a DataSource.
CriteriaChangedEvent
CriteriaChangedEvent
CriteriaChangedHandler
CriteriaChangedHandler
CriteriaCombineOperator
The logical operator to use when combining criteria objects with the `DataSource.combineCriteria()` method.
CriteriaEditing
Criteria Editing
CriteriaOutputSettings
Settings for generation of AdvancedCriteria descriptions.
CriteriaPolicy
Criterion
An object representing a criterion to apply to a record.
Criterion
An object representing a criterion to apply to a record.
CSSColor
CSS color specification applied to a specific HTML element on this page.
CSSEditor
A `Layout`-based component for editing groups of `styling settings`.
CSSEditorLogicalStructure
CSSStyleName
CSS class name to apply to some HTML element on this page.
CSSText
A String of CSS that can be added directly to a `style` attribute.
CubeGrid
The CubeGrid is an interactive grid component that presents very large, multi-dimensional data sets (also known as data cubes) for reporting or analytic applications.
CubeGridLogicalStructure
Cues
Visual hints for the user that something can be done to this object
CurrentPane
Possible values for the current pane showing in a `SplitPane`.
CurrentViewChangedEvent
CurrentViewChangedHandler
Cursor
The following APIs are all related to Cursor.
Cursor
You can use whatever cursors are valid for your deployment platforms, but keep in mind that visual representation may vary by browser and OS.
CustomQuerying
Custom Querying Overview
CustomSassSkins
Customizing Sass-based Skins
CustomTabElements
Including custom elements in the tab order
CustomValidator
Data
The following APIs are all related to Data.
DataArrivedEvent
DataArrivedEvent
DataArrivedEvent
DataArrivedEvent
DataArrivedEvent
DataArrivedHandler
DataArrivedHandler
DataArrivedHandler
DataArrivedHandler
DataArrivedHandler
Databinding
DataBinding
DataBoundAIRequest
DataBoundComponent
A DataBoundComponent is a widget that can configure itself for viewing or editing objects which&#010 share a certain schema by "binding" to the schema for that object (called a "DataSource").
DataBoundComponentMethods
DataBound Component Methods
DataChangedEvent
DataChangedEvent
DataChangedEvent
DataChangedEvent
DataChangedEvent
DataChangedHandler
DataChangedHandler
DataChangedHandler
DataChangedHandler
DataChangedHandler
DataClass
DataContext
The following APIs are all related to DataContext.
DataContext
A mapping from `DataSource` IDs to specific `Records`.
DataContextBinding
Identical to a `DataContext` but in addition to fixed values, `ruleContext` values can be specified by prefixing the `ruleContext` path with `$ruleScope.` as shown below:
DataLabelClickEvent
DataLabelClickHandler
DataLabelHoverCustomizer
DataLabelHoverEvent
DataLabelHoverHandler
DataLineType
Algorithms for drawing lines between points.
DataPath
String specifying a nested data field structure.
DataPoints
The following APIs are all related to DataPoints.
DataQuestion
Represents a data question and either the steps taken in attempting to answer it or the result.
DataQuestionResult
The result of the data question.
DataQuestionSettings
Settings for a data question.
DataQuestionStep
An object that contains information about a step in an Answer Engine operation.
DataQuestionStepResult
DataQuestionStepType
DataSource
A DataSource is data-provider-independent description of a set of objects that will be loaded, edited and saved within the user interface of your application.
DataSource
A DataSource is data-provider-independent description of a set of objects that will be loaded, edited and saved within the user interface of your application.
DataSourceBaseValueType<ValueType extends DataSource>
DataSourceBinaryField
DataSourceBooleanField
DataSourceDateField
DataSourceDateTimeField
DataSourceDeclaration
Creating DataSources
DataSourceEnumField
DataSourceField
Metadata about a DataSourceField, including its type and validators.
DataSourceField
Metadata about a DataSourceField, including its type and validators.
DataSourceFloatField
DataSourceImageField
DataSourceImageFileField
DataSourceIntegerField
DataSourceIntEnumField
DataSourceLinkField
DataSourceLocalization
DataSource and Component XML Localization
DataSourceOperations
DataSource Operations
DataSourcePasswordField
DataSourceRelations
Relations
DataSourceSequenceField
DataSourceSimpleTypeField
A DataSourceField that is based on a user created `SimpleType`.
DataSourcesTab
DataSources Tab
DataSourceTemplateReferenceMode
Indicates the mode to use for resolving templated references in a DataSource's configuration file.
DataSourceTextField
DataSourceTimeField
DataType
The following APIs are all related to DataType.
DataURLCallback
DataURLFormat
The data URL MIME type to use when `DrawPane.getDataURL()` is called to convert the drawing to a data URL.
DataView
A DataView coordinates the asynchronous loading of WSDL WebService and XML Schema definitions in applications created by Reify.
DataViewLogicalStructure
Date
The following APIs are all related to Date.
DateCellAlignCustomizer
Called to determine the horizontal Alignment of the content in s given date cell in a CalendarView
DateCellVAlignCustomizer
Called to determine the vertical Alignment of the content in s given date cell in a CalendarView
DateChangedEvent
DateChangedHandler
DateChooser
Simple interactive calendar interface used to pick a date.
DateChooser.YearTitleFormatter
A customizer that allows you to alter the year representations used in various places in the DateChooser widget.
DateChooserLogicalStructure
DateCSSTextCustomizer
Called to determine additional CSS text for a given date in a given view
DateDisplayFormat
Valid display formats for dates.
DateDisplayFormatter
DateDisplayFormatter interface.
DateEditingStyle
The type of date/time editing style to use when editing an event.
DateFieldClickEvent
DateFieldClickHandler
DateFieldLayout
The direction in which an item should lay out it's fields.
DateFormatAndStorage
Date and Time Format and Storage
DateFormatStringFormatter
DateGrid
A ListGrid subclass that manages calendar views.
DateGridLogicalStructure
DateHeaderCustomizer
Called to determine the HTML to be displayed in the header for a given date column in a CalendarView
DateHTMLCustomizer
Called to determine the HTML to be displayed in a given date cell in a CalendarView
DateInputFormat
3 character string containing the `"M"`, `"D"` and `"Y"` characters to indicate the format of strings being parsed into Date instances via `DateUtil.parseInput()`.
DateInputFormatter
DateInputFormatter.
DateItem
A `FormItem` for editing `logical-Date` values, where times are ignored.
DateItemAppearance
The following APIs are all related to DateItemAppearance.
DateItemEditProxy
`EditProxy` that handles `DateItem` when editMode is enabled.
DateItemSelectorFormat
Order of pickers and which pickers are present when using a DateItem with `DateItem.useTextField` false.
DateParser
Custom parser for converting formatted date strings to live Date objects.
DateRange
A class specifying a range of dates.
DateRangeCallback
DateRangeDialog
Simple modal dialog for collecting a date range from the end user.
DateRangeDialogLogicalStructure
DateRangeItem
Allows a user to select an absolute or relative range of dates via two `RelativeDateItem`s (if `allowRelativeDates` is true) or two `DateItems`.
DateRangeValidator
Tests whether the value for a date field is within the range specified by validator.min and validator.max, which should be dates.
DateStyleCustomizer
Called to determine the CSS class name for a given date in a given view
DateTimeItem
A simple `DateItem subclass` for editing `regular datetime` values, where date and time elements are relevant.
DateUtil
Static singleton class containing APIs for interacting with Dates.
DateValueType
DayBodyClickEvent
DayBodyClickHandler
DayHeaderClickEvent
DayHeaderClickHandler
DBCField
Represents a field in a `DataBoundComponent`.
DbConfigTool
Database Configuration
Debugging
Debugging
DebugModules
Using the Debug Modules
DebugOverflowSettings
Configuration to control how excessive overflow is reported when you're `debugging overflow`.
DecisionBranch
Identifies a potential branch within a `MultiDecisionTask`.
DecisionGateway
Chooses a next element in a `Process` by evaluating a series of criteria against the `Process.state` and choosing the element associated with the criteria that matched, or a `defaultElement` if none of the criteria match.
DecisionTask
Chooses one or another next process element based on AdvancedCriteria applied to `Process.state`.
Deck
A simple container that implements the policy that at most one of its contained components is visible at any given time.
DeckLogicalStructure
DeclarativeSecurity
Declarative Security
DefaultFieldWidthCustomizer
DefaultQueryClause
The Velocity variable names of the "pieces" of SQL that Smart GWT generates to form a complete fetch or update query.
DefaultSampleRecord
Some interfaces, for example the `FieldPicker` and `HiliteEditor` widgets, can use data from an associated DataBoundComponent to express live sample values at runtime.
DeploymentManagement
Deployment Management Console
DeprecatedModuleWarningLinker
DeprecatedModuleWarningLinker
DetailFormatter
DetailViewer
Displays one or more records "horizontally" with one property per line.
DetailViewerEditProxy
`EditProxy` that handles `DetailViewer` components when editMode is enabled.
DetailViewerField
An object literal with a particular set of properties used to configure the display of and interaction with the rows of a `DetailViewer`.
DetailViewerFieldIfFunction
DetailViewerLogicalStructure
DetailViewerRecord
A DetailViewerRecord is an object literal with properties that define the values for the various fields of a `DetailViewer`.
DetailViewerViewState
An object containing the stored grouping information for a detailViewer.
DevConsoleRPCTab
The Developer Console RPC Tab
DeviceMode
Possible layout modes for UI components that are sensitive to the device type being used (a.k.a.
DevModeTroubleshooting
Troubleshooting GWT Development Mode
DevTools
Dashboards & Tools Framework Overview
Dialog
Dialogs are a specialized version of `Window` used for small windows that contain just a text message or a text mesage with some standard buttons.
DialogLogicalStructure
Direction
DisableDateCustomizer
Called to determine whether the passed date should be considered disabled in the passed view
DiscoverTreeSettings
Defines a set of properties that specify how the tree will be explored by `Tree.discoverTree()`
Display
The following APIs are all related to Display.
DisplayNodeType
Flag passed to functions as displayNodeType, telling the function whether it should work on folders, leaves or both at once.
DMI
This class provides static methods to call server-side DMI methods exposed via a `ApplicationDeclaration` file.
DMI
Deprecated.
This class is deprecated in favor of `DMI`.
DMI
Deprecated.
This class is deprecated in favor of `DMI`.
DMI
Deprecated.
This class is deprecated in favor of `DMI`.
DmiOverview
Direct Method Invocation
DoesntContainValidator
Determine whether a string value does not contain some substring specified via validator.substring.
DomIntegration
DOM Integration & Third-party Components
DOMUtil
DOM related helper methods.
DoubleClickEvent
DoubleClickEvent
DoubleClickEvent
DoubleClickHandler
DoubleClickHandler
DoubleClickHandler
DoubleItem
TextForm item for managing a text field that displays a decimal value.
DoubleValueType
DownClickEvent
DownClickHandler
Drag
The following APIs are all related to Drag.
DragAppearance
Different types of effects for showing dragging behavior.
DragCompleteEvent
DragCompleteHandler
DragDataAction
What do we do with data that's been dropped into another list?
DragDataCustomizer
Dragdrop
Drag and Drop
Dragging
The following APIs are all related to Dragging.
DragHandleField
The following APIs are all related to DragHandleField.
DragHoverCustomizer
Called to determine the hover text to show during drag operations in Calendars
DragIntersectStyle
Different styles of determining intersection: with mouse or entire rect of target
DragMaskType
What kind of mask to use for masking dragged element.
DragMove
DragMoveEvent
DragMoveHandler
DragMoveHandler
Dragndrop
The following APIs are all related to Dragndrop.
DragRepositionMoveEvent
DragRepositionMoveHandler
DragRepositionStartEvent
DragRepositionStartHandler
DragRepositionStopEvent
DragRepositionStopHandler
DragResize
The following APIs are all related to DragResize.
DragResizeMoveEvent
DragResizeMoveEvent
DragResizeMoveHandler
DragResizeMoveHandler
DragResizeStartEvent
DragResizeStartEvent
DragResizeStartHandler
DragResizeStartHandler
DragResizeStopEvent
DragResizeStopEvent
DragResizeStopHandler
DragResizeStopHandler
DragStart
DragStartEvent
DragStartHandler
DragStartHandler
DragStop
DragStopEvent
DragStopHandler
DragStopHandler
DragTracker
The following APIs are all related to DragTracker.
DragTrackerIconCustomizer
Hover customizer object for returning a different icon when a user has selected record(s) and is dragging them.
DragTrackerMode
When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed?
DragTrackerTitleCustomizer
Hover customizer object for returning a different icon when a user has selected record(s) and is dragging them.
DrawAreaChangedEvent
DrawAreaChangedHandler
DrawBlockConnector
DrawItem subclass to render multi-segment, orthogonal-routing paths.
DrawBlockConnectorLogicalStructure
DrawContext
The following APIs are all related to DrawContext.
DrawCurve
DrawItem that renders cubic bezier curves.
DrawCurveLogicalStructure
DrawDiamond
DrawItem subclass to render diamond shapes
DrawDiamondLogicalStructure
DrawEndEvent
DrawEndHandler
DrawEvent
DrawGroup
DrawItem subclass to manage a group of other DrawItem instances.
DrawGroupLogicalStructure
DrawHandler
DrawImage
DrawItem subclass to render embedded images.
DrawImageLogicalStructure
Drawing
Rendering an object on the page.
DrawingType
The type of drawing back-end used by a `DrawPane` to draw its `draw items` on screen.
DrawItem
Base class for graphical elements drawn in a DrawPane.
DrawItemEditProxy
`EditProxy` that handles `DrawItems` except for `DrawLabels` when editMode is enabled.
DrawItemLogicalStructure
DrawKnob
Canvas that renders a `DrawItem` into a `DrawPane` and provides interactivity for that drawItem, including drag and drop.
DrawKnobLogicalStructure
DrawLabel
DrawItem subclass to render a single-line text label.
DrawLabelEditProxy
`EditProxy` that handles `DrawLabels` when editMode is enabled.
DrawLabelLogicalStructure
DrawLine
DrawItem subclass to render line segments.
DrawLineLogicalStructure
DrawLinePath
DrawItem subclass to render a connector between two points.
DrawLinePathLogicalStructure
DrawnValue
Returns information about how a data value is rendered in a chart.
DrawOval
DrawItem subclass to render oval shapes, including circles.
DrawOvalLogicalStructure
DrawPane
A DrawPane is a container for drawing bitmap and vector graphics using browser's built-in freeform drawing capabilities.
DrawPane.InvalidDrawingTypeException
DrawPaneEditProxy
`EditProxy` that handles `DrawPanes` when editMode is enabled.
DrawPaneLogicalStructure
DrawPath
Draws a multi-segment line.
DrawPathLogicalStructure
DrawPolygon
DrawItem subclass to render polygons
DrawPolygonLogicalStructure
DrawPosition
DrawRect
DrawItem subclass to render rectangle shapes, optionally with rounded corners.
DrawRectLogicalStructure
DrawSector
DrawItem subclass to render Pie Slices.
DrawSectorLogicalStructure
DrawShape
DrawItem to render a shape defined by executing the series of drawing commands in the `commands` array.
DrawShapeCommand
Holds the information of a drawing command.
DrawShapeCommandType
DrawShapeLogicalStructure
DrawStartEvent
DrawStartHandler
DrawTriangle
DrawItem subclass to render triangles
DrawTriangleLogicalStructure
DropCompleteEvent
DropCompleteHandler
DropEvent
DropHandler
DropMoveEvent
DropMoveHandler
DropOutEvent
DropOutHandler
DropOverEvent
DropOverHandler
DSAddTask
A `ServiceTask` configured to perform an add.
DSCallback
DSDataFormat
Indicates the format to be used for HTTP requests and responses when fulfilling DSRequests (eg, when `DataSource.fetchData()` is called).
DsFacade
DataSource Facade pattern
DSFetchTask
A `ServiceTask` configured to perform a fetch.
DSInheritanceMode
For DataSources of type "sql" and "hibernate", specifies the kind of inheritance to use when a dataSource specifies `inheritsFrom`.
DSLoadSettings
Settings to control optional `DataSource loading` features.
DSOperationType
One of the four basic operations that can be performed on DataSource data: "fetch", "add", "update", "remove".
DSProtocol
`OperationBinding.dataProtocol` affects how the data in the DSRequest (`DSRequest.data`) is sent to the `DataSource.dataURL`.
DSRemoveTask
A `ServiceTask` configured to perform a remove.
DSRequest
Request sent to the server to initiate a `DataSource operation`.
DsRequestBeanTypes
DSRequest data auto-converted to bean types
DsRequestEquivalence
Various subsystems have a need to compare DataSource requests and understand if they are equivalent or affect the same data (examples include `automatic cache synchronization` and `offline caching and synchronization`).
DSRequestModifier
An object that modifies a dsRequest based on several available values, including preceding responses from the same queue.
DsResponse
The following APIs are all related to DsResponse.
DSResponse
Response sent by the server in response to a `DataSource request`.
DSServerType
Indicates what Smart GWT Server will do with a DataSource request if you call dsRequest.execute() in server code.
DsSpecialFields
A DataSource allows you to declare that certain fields are the most important fields to show to a user in situations where space is limited, and only one or a few fields can be reasonably shown.
DSUpdateTask
A `ServiceTask` configured to perform a update.
DynamicCriteria
If a property indicates it has support for "dynamic criteria" it means that values in the criteria may be dynamically derived from the current `Canvas.ruleScope` using `Criterion.valuePath`.
DynamicForm
The DynamicForm manages a collection of FormItems which represent user input controls.
DynamicFormLogicalStructure
DynamicLoading
DynamicMenuItem
The following APIs are all related to DynamicMenuItem.
DynamicString
A `dynamic string`.
DynamicStrings
Dynamic Strings
EdgedCanvas
EdgedCanvas acts as a decorative, image-based frame around another single Canvas.
EdgedCanvasLogicalStructure
EdgeName
An edge or corner of a rectange, or it's center.
EdgeSizes
Object used to specify custom edge sizes or offsets.
EditCompleteEvent
EditCompleteEvent
EditCompleteHandler
EditCompleteHandler
EditCompletionEvent
What event / user interaction type caused cell editing to complete.
EditContext
An EditContext provides an editing environment for a set of components.
EditFailedEvent
EditFailedHandler
Editing
Grid Editing
EditMaskClickedEvent
EditMaskClickedHandler
EditNode
An object representing a component that is currently being edited within an `EditContext`.
EditNodeUpdatedEvent
EditNodeUpdatedHandler
EditorEnterEvent
EditorEnterEvent
EditorEnterHandler
EditorEnterHandler
EditorExitEvent
EditorExitEvent
EditorExitHandler
EditorExitHandler
EditorValueMapFunction
EditPane
A container that allows drag and drop instantiation of visual components from a `Palette`, and direct manipulation of the position and size of those components.
EditPaneLogicalStructure
EditProxy
An EditProxy is attached to an editable component when editMode is enabled.
EditSearchWindow
Window that simply contains a `SavedSearchEditor` as the `com.smartgwt.client.types.AutoChild` `savedSearchEditor`.
EditSearchWindowLogicalStructure
EditTree
A TreeGrid that allows drag and drop creation and manipulation of a tree of objects described by DataSources.
EditTreeLogicalStructure
Elements
Manipulating native form elements
ElementWaitConfig
Configuration object for `AutoTest.waitForElement()`
ElementWaitStyle
How should `AutoTest.waitForElement()` determine that the application is ready to retrieve the element?
EmbeddedPosition
How a component should be embedded within its record or cell
EmptyMessage
The following APIs are all related to EmptyMessage.
Enable
Enabling and Disabling
Encoding
Form encoding types - these translate to Form ENCTYPE parameters.
EndProcessTask
Task that ends a workflow.
EnterKeyEditAction
What to do when a user hits enter while editing a cell
EnumTranslateStrategy
Determines how Java enums are translated to and from Javascript by the Smart GWT server.
EnumUtil
Utils for manipulate with a Enum.
EnumValueType<ValueType extends Enum<ValueType>>
EqualsValidator
Determine whether a value matches a value specified via `value`.
ErrorEvent
ErrorHandling
Error Handling Overview
ErrorIcon
The following APIs are all related to ErrorIcon.
Errors
Validation errors and how they are shown
EscapeKeyEditAction
What to do if the user hits escape while editing a cell.
EscapingMode
Mode for escaping text values when using `DataSource.recordsAsText()` or `DataSource.recordsFromText()`.
EventAddedHandler
EventBodyHTMLCustomizer
Called to determine the body/description HTML to be displayed in an event's EventCanvas
EventCanvas
The EventCanvas component is a lightweight `layout` subclass for displaying a `CalendarEvent` in a `CalendarView`.
EventCanvasComponentCustomizer
Called to create and update the components shown in EventCanvas instances when Calendar.showEventCanvasComponents is true.
EventCanvasGripperIconCustomizer
Called to determine the CSS class name for a given event in a given view
EventCanvasHoverHTMLCustomizer
Called to determine the hover HTML to be displayed when the user hovers over an eventCanvas in a calendar.
EventCanvasLogicalStructure
EventCanvasMenuCustomizer
Called to determine the hover HTML to be displayed when the user hovers over an eventCanvas in a calendar.
EventChangedHandler
EventClickHandler
EventDialogCustomizer
Called whenever a Calender needs to show the EventDialog, to view or create a CalendarEvent
EventEditorCustomizer
Called whenever a Calender needs to show an EventEditor, to edit or create a CalendarEvent
EventErrorCallback
EventHandler
SmartGWT provides a predictable cross-browser event-handling mechanism for SmartGWT widgets, and the EventHandler class provides various static APIs for retrieving details about events which have occurred.
EventHeaderHTMLCustomizer
Called to determine the header/title HTML to be displayed in an event's EventCanvas
EventRegistry
The following APIs are all related to EventRegistry.
EventRemoveClickHandler
EventRemovedHandler
EventRepositionMove
EventRepositionMoveHandler
EventRepositionStop
EventRepositionStopHandler
EventResizeMove
EventResizeMoveHandler
EventResizeStop
EventResizeStopHandler
EventSaveError
EventSaveErrorHandler
EventsRenderedEvent
EventsRenderedHandler
EventStream
Note: this is currently an experimental feature and not covered by normal support guarantees.
EventStreamData
Note: this is currently an experimental feature and not covered by normal support guarantees.
EventStreamEvent
Note: this is currently an experimental feature and not covered by normal support guarantees.
EventStyleCustomizer
Called to determine the CSS class name for a given event in a given view
ExcelPasting
Copy and Paste with Excel
ExecuteQueryDataQuestionStep
ExecuteQueryDataQuestionStepResult
ExpandSectionCallback
ExpansionComponentPoolingMode
The method of pooling to employ for `expansionComponents`.
ExpansionField
The following APIs are all related to ExpansionField.
ExpansionMode
When `canExpandRecords` is true, ExpansionMode dictates the type of UI to be displayed in the expanded portion of the row.
Experimental
Experimental Features
ExportBackgroundColor
The following APIs are all related to ExportBackgroundColor.
ExportBGColor
Exports & Cell Background Color
ExportDisplay
Method to use for displaying the exported data.
ExportFormat
One of the supported formats for data-export.
ExportFormatting
Exports & Formatting
ExportImageCallback
ExportImageFormat
One of the supported formats for image export.
FacadeDataSource
Extends an arbitrary `DataSource` with the ability to queue requests made on it and dispatch the queued requests on demand.
Facet
Facet definition object made use of by the `CubeGrid` and `FacetChart` classes.
FacetAddedEvent
FacetAddedHandler
FacetChart
HTML5-based charting engine, implementing all chartTypes of the Chart interface.
FacetChartEditProxy
`EditProxy` that handles `FacetCharts` when editMode is enabled.
FacetChartLogicalStructure
FacetContextClickEvent
FacetContextClickHandler
FacetIndentDirection
Specifies the direction of facet indenting for a `hierarchical` facet.
FacetLabelClickEvent
FacetLabelClickHandler
FacetMovedEvent
FacetMovedHandler
FacetRemovedEvent
FacetRemovedHandler
FacetValue
Facet value definition object made use of by the `CubeGrid` and `FacetChart` classes (contained by facets).
FacetValueContextClickEvent
FacetValueContextClickHandler
FacetValueHoverCustomizer
Hover customizer object for returning custom HTML to display in a hover prompt for CubeGrid facetValues
FacetValueMap
An object mapping `facet ids` to `facetValue ids` within a facet
FacetValueSelectionChangedEvent
FacetValueSelectionChangedHandler
FeaturesCustomPersistence
Server Features and Custom Persistence
FetchDataEvent
FetchDataHandler
Fetching
The following APIs are all related to Fetching.
FetchMode
Mode of fetching records from the server.
FetchRelatedDataTask
Fetch data related to a record in another component.
Field
Base type representing a field.
FieldAppearance
FieldAuditMode
FieldFilterMode
Indicates where a given field can be legally filtered.
FieldGeneration
The following APIs are all related to FieldGeneration.
FieldImportStrategy
Options for how values in the import dataset (for example, the CSV file) are transformed during import if the field is a `foreignKey` mapped to a `displayField`
FieldLevelAuth
Field-Level Security
FieldName
Name for a field.
FieldNamingStrategy
The strategy to use when generating field names - for example, for new formula or summary fields created using the built-in editors.
FieldOperatorCustomizer
Customizer that returns the list of OperatorIds applicable to a given field.
FieldPicker
FieldPicker provides a configuration dialog that displays, side-by-side, the available and currently-displayed fields of a `DataBoundComponent`.
FieldPickerCallbackCustomizer
Customizer called when the settings in a FieldPicker are accepted.
FieldPickerLogicalStructure
FieldPickerWindow
A dialog for picking fields to display from among the available fields.
FieldPickerWindowLogicalStructure
Fields
The following APIs are all related to Fields.
FieldState
An object containing the stored presentation information for the fields of some dataBoundComponent.
FieldStateChangedEvent
FieldStateChangedHandler
FieldType
The types listed below are built-in types that `databound\n components` understand and treat specially (using type-specific form controls, validators, formatters, sorting logic, etc).
FieldValueExtractor
FileAssembly
File Assembly
FileItem
Binary data interface for use in DynamicForms.
FileItemEditProxy
`EditProxy` that handles `FileItems` when editMode is enabled.
FileLoader
Helper class to preload skin images.
Files
Referring to and loading other files.
FileSource
FileSource Operations
FileSpec
A record which specifies files for use with `FileSource Operations`.
FilterBuilder
A form that allows the user to input advanced search criteria, including operators on field values such as "less than", and sub-clauses using "AND" and "OR" operators.
FilterBuilderLogicalStructure
FilterChangedEvent
FilterChangedHandler
FilterClause
A horizontal, Layout-based widget that allows a user to input a single criterion based on one field and one operator.
FilterClauseLogicalStructure
FilterCriteriaFunction
Criteria function for pick lists.
FilterEditor
The following APIs are all related to FilterEditor.
FilterEditorSubmitEvent
FilterEditorSubmitHandler
FilteredList
A subclass of `ResultSet` designed to provide a synchronously filterable List interface for an array of data.
FilteredSelectAllAction
Governs how the `MultiPickerItem` "Select All" and "Deselect All" buttons should act when the user has filtered the set of visible options in the list.
FilterSearchEvent
FilterViaAIProgressDialog
FilterViaAIProgressDialogLogicalStructure
FilterViaAISettings
Settings to use for filtering a `DataBoundComponent` via AI.
FinishedHandler
FireStyle
Flags to set automatic removal of events from the page event registry.
FiscalCalendar
An object representing the start date for fiscal years in the current locale.
FiscalYear
An object representing the start of a given Fiscal Year in the current locale.
FiscalYearMode
Strategies for calculating the FiscalYear within a `FiscalCalendar` from the specified `FiscalCalendar.defaultDate` and `FiscalCalendar.defaultMonth` If the specified fiscal year date starts in one calendar year and ends in the next.
FixDashboardComponentDataQuestionStep
FixDashboardComponentDataQuestionStepResult
FixedFacetValueChangedEvent
FixedFacetValueChangedHandler
Flashlet
ISC abstraction for Flashlets.
FlashletLogicalStructure
FlatFields
The following APIs are all related to FlatFields.
FloatItem
A TextItem for managing a text field that displays a floating point value.
FloatPrecisionValidator
Tests whether the value for this field is a floating point number with the appropriate number of decimal places - specified in validator.precision If the value is of higher precision, if validator.roundToPrecision is specified, the value will be rounded to the specified number of decimal places and validation will pass, otherwise validation will fail.
FloatRangeValidator
Tests whether the value for this field is a floating point number within the range specified by validator.min and validator.max.
FloatValueType
FlowLayout
Arranges a set of Canvas components into rows, flowing into available space so that different numbers of components may appear in each row.
FlowLayoutLogicalStructure
Focus
Focus
FocusChangedEvent
FocusChangedHandler
FocusEvent
FocusHandler
FolderClickEvent
FolderClickHandler
FolderClosedEvent
FolderClosedHandler
FolderContextClickEvent
FolderContextClickHandler
FolderDropEvent
FolderDropHandler
FolderOpenedEvent
FolderOpenedHandler
FontLoader
Force-loads the custom fonts declared in the `current skin's CSS file` and updates any potentially-affected, already-drawn canvii when loading completes.
FontLoadingFailedEvent
FontLoadingFailedHandler
FontsLoadedEvent
FontsLoadedHandler
FooterControls
ForceTextApproach
Approach to force a text value to be interpreted as text rather than parsed as a date, time or other structured types, as can happen with Microsoft Excel.
Format
Deprecated.
see `Localized Number Formatting` for details.
FormatString
A String to be used as a format specifier for a date, datetime, time or numeric field, via the `format` and `exportFormat` properties.
FormattedTimingDataCallback
FormattingContext
The context for which a data-value is being formatted.
FormClearValuesTask
Clear form values and errors.
FormDisableFieldTask
Disable or enable a form field.
FormEditNewRecordTask
Start editing a new record.
FormEditProxy
`EditProxy` that handles `DynamicForms` when editMode is enabled.
FormEditRecordTask
Edit a record currently showing in some other component.
FormEditSelectedTask
Edit a record currently selected in some other component.
FormErrorOrientation
FormIcons
The following APIs are all related to FormIcons.
FormItem
A UI component that can participate in a DynamicForm, allowing editing or display of one of the `values tracked by the form`.
FormItem.CustomStateGetter
FormItem.StateCustomizer
FormItemBaseStyle
This string is the base CSS class name applied to a FormItem (or some part of a form item).
FormItemCanEditCriterionPredicate
FormItemClassName
Name of a Smart GWT Class that subclasses `FormItem`.
FormItemClickHandler
FormItemCriteriaFunction
Interface containing a method to return filter criteria for use by some form item.
FormItemCriterionGetter
FormItemCriterionSetter
FormItemEditProxy
`EditProxy` that handles `FormItem`s when editMode is enabled.
FormItemElementType
HTML elements that make up a complete FormItem (note, not all FormItems use all of these elements)
FormItemErrorFormatter
Formatter to customize the error message of a FormItem
FormItemEventInfo
A class containing details for mouse events occurring over a FormItem.
FormItemFactory
FormItemFunctionContext
Context object passed to FormItemFunctions containing information about the form item on which the function was fired
FormItemHoverFormatter
If defined, this method should return the HTML to display in a hover canvas when the user holds the mousepointer over this item.
FormItemIcon
Form item icon descriptor objects used by Form Items to specify the appearance and behavior of icons displayed after the item in the page flow.
FormItemIconClickEvent
FormItemIfFunction
FormItemInitHandler
FormItemInputTransformer
FormItemMetaBeanFactoryGenerator
FormItemStyling
FormItem Styling
FormItemType
FormItemValueFormatter
FormItemValueParser
FormLayout
Form Layout
FormLayoutType
FormMethod
Form METHOD parameters - how the form fields are submitted to the server
FormResetValuesTask
Revert unsaved changes in a form.
FormSaveDataTask
Saves changes made in a form (validates first).
FormSetFieldValueTask
Put a value in just one field of a form.
FormSetValuesTask
Set form values.
FormSubmitFailedEvent
FormSubmitFailedHandler
FormTitles
Form Titles
FormulaFields
Fields with values calculated from other fields in the grid.
FormulaFunction
DataSourceField formula functions
FormulaUpdated
FormulaUpdatedHandler
FormValidateValuesTask
Validate a form and show errors to user.
FormValues
The following APIs are all related to FormValues.
FormValuesManager
Values Manager
FrozenFields
Frozen Fields
Function
GaeIntegration
Google Application Engine (GAE)
Gauge
The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle on a dial.
GaugeLogicalStructure
GaugeSector
Represents a sector on the gauge.
GetFieldValueCallback
GetFileCallback
GetFileVersionCallback
GetPropertiesTask
Gets the value properties from a component and makes them available within the workflow as the `last task output`.
GettingCanvasSize
Determining the size of a drawn canvas
GlobalId
An `Identifier` that's unique in the global scope.
Gradations
The following APIs are all related to Gradations.
Gradient
Defines a simple gradient vertical gradient between `two` `colors`, or using `colorStops`.
GradientChangedEvent
GradientChangedHandler
GradientEditor
A widget for visually editing CSS gradients.
GradientEditorLogicalStructure
GradientMapper
GridEditProxy
`EditProxy` that handles `ListGrid` and `TreeGrid` components when editMode is enabled.
GridEditRecordTask
Edit an existing record in a grid or start editing a new one.
GridExportClientDataTask
Export data currently shown in a grid keeping all grid-specific formatting.
GridExportDataTask
Export data currently shown in a grid.
GridFetchDataTask
Fetch data matching specified criteria into grid.
GridFiltering
Grid Filtering Overview
GridHeader
Properties and methods related to the ListGrid header.
GridRemoveSelectedDataTask
Remove data that is selected in a grid.
GridRenderer
A flexible, high-speed table that offers consistent cross-platform sizing, clipping, and events.
GridRowColEvent<H extends EventHandler>
GridSaveAllEditsTask
Save all changes in a grid which has auto-saving disabled.
GridSelectRecordsTask
Select or deselect one or more records as specified by criteria.
GridSetEditValueTask
Sets the edit value of a given field.
GridSummaryCustomizer
If ListGrid.showGridSummary is true, and this method is specified it will be called to generate the summary value to be displayed in the grid summary row.
GridTransferDataTask
Transfer selected records from one grid to another.
GridValidation
ListGrids support automatic validation of edited cells / records.
GridViewSelectedDataTask
View a record currently selected in some other component.
Grip
The following APIs are all related to Grip.
GroupByCompleteEvent
GroupByCompleteHandler
GroupByEvent
GroupByHandler
Grouping
The following APIs are all related to Grouping.
GroupNode
An auto-generated class representing the group nodes in a grouped listgrid.
GroupSortNormalizer
GroupSpecifier
Class defining the details of a single group operation
GroupStartOpen
Possible values for the state of ListGrid groups when groupBy is called
GroupStateChangedEvent
GroupStateChangedHandler
GroupSummary
Group Summary.
GroupSummaryCustomizer
If `ListGrid.getShowGroupSummary()` is true, and this method is specified it will be called to generate the field summary value to be displayed for each group level summary row.
GroupTitleFunction
Provides a way to override the default behavior of `SimpleType.getGroupTitle()`.
GroupTitleRenderer
Group title renderer function.
GroupTreeChangedEvent
GroupTreeChangedHandler
GroupTreeChangeType
Type of change to the `ListGrid.groupTree`.
GroupValueFunction
Provides a way to override the default behavior of `SimpleType.getGroupValue()`.
GroupValueFunction
Function to return the value which records should be grouped by.
GwtFloatVsDouble
Float vs Double
HandleErrorCallback
HandleErrorHandler
HandleTransportErrorCallback
HasAceEditorChangedHandlers
HasAddTabClickedHandlers
Deprecated.
HasAddTabClickHandlers
HasApplyClickHandlers
HasApplyClickHandlers
HasAsyncValidationReplyHandlers
HasAsyncValidationReplyHandlers
HasBackgroundClickHandlers
HasBackgroundMouseDownHandlers
HasBackgroundMouseUpHandlers
HasBeforeCommitHandlers
HasBlurHandlers
HasBodyKeyPressHandlers
HasButtonClickHandlers
HasCancelClickHandlers
HasCancelClickHandlers
HasCanEditChangedHandlers
HasCellClickHandlers
HasCellContextClickHandlers
HasCellDoubleClickHandlers
HasCellErrorIconHoverHandlers
HasCellErrorIconOutHandlers
HasCellErrorIconOverHandlers
HasCellHoverHandlers
HasCellMouseDownHandlers
HasCellMouseUpHandlers
HasCellOutHandlers
HasCellOverHandlers
HasCellSavedHandlers
HasCellSelectionChangedHandlers
HasCellValueHoverHandlers
HasChangedHandlers
HasChangedHandlers
HasChangeHandlers
HasChangeHandlers
HasChartBackgroundDrawnHandlers
HasChartDrawnHandlers
HasClearHandlers
HasClickHandlers
HasClickHandlers
HasClickHandlers
HasClickHandlers
HasCloseClickHandlers
HasCloseClickHandlers
HasColorChangedHandlers
HasColorSelectedHandlers
HasContentLoadedHandlers
HasCriteriaChangedHandlers
HasCriteriaChangedHandlers
HasCurrentViewChangedHandlers
HasDataArrivedHandlers
HasDataArrivedHandlers
HasDataArrivedHandlers
HasDataArrivedHandlers
HasDataArrivedHandlers
HasDataChangedHandlers
HasDataChangedHandlers
HasDataChangedHandlers
HasDataChangedHandlers
HasDataChangedHandlers
HasDataLabelClickHandlers
HasDataLabelHoverHandlers
HasDateChangedHandlers
HasDateFieldClickHandlers
HasDayBodyClickHandlers
HasDayHeaderClickHandlers
HasDoubleClickHandlers
HasDoubleClickHandlers
HasDoubleClickHandlers
HasDownClickHandlers
HasDragCompleteHandlers
HasDragMoveHandlers
HasDragMoveHandlers
HasDragRepositionMoveHandlers
HasDragRepositionStartHandlers
HasDragRepositionStopHandlers
HasDragResizeMoveHandlers
HasDragResizeMoveHandlers
HasDragResizeStartHandlers
HasDragResizeStartHandlers
HasDragResizeStopHandlers
HasDragResizeStopHandlers
HasDragStartHandlers
HasDragStartHandlers
HasDragStopHandlers
HasDragStopHandlers
HasDrawAreaChangedHandlers
HasDrawEndHandlers
HasDrawHandlers<T>
HasDrawStartHandlers
HasDropCompleteHandlers
HasDropHandlers
HasDropMoveHandlers
HasDropOutHandlers
HasDropOverHandlers
HasEditCompleteHandlers
HasEditCompleteHandlers
HasEditFailedHandlers
HasEditMaskClickedHandlers
HasEditNodeUpdatedHandlers
HasEditorEnterHandlers
HasEditorEnterHandlers
HasEditorExitHandlers
HasEditorExitHandlers
HasEventAddedHandlers
HasEventChangedHandlers
HasEventClickHandlers
HasEventRemoveClickHandlers
HasEventRemovedHandlers
HasEventRepositionMoveHandlers
HasEventRepositionStopHandlers
HasEventResizeMoveHandlers
HasEventResizeStopHandlers
HasEventSaveErrorHandlers
HasEventsRenderedHandlers
HasFacetAddedHandlers
HasFacetContextClickHandlers
HasFacetLabelClickHandlers
HasFacetMovedHandlers
HasFacetRemovedHandlers
HasFacetValueContextClickHandlers
HasFacetValueSelectionChangedHandlers
HasFetchDataHandlers
HasFieldStateChangedHandlers
HasFileCallback
HasFileVersionCallback
HasFilterChangedHandlers
HasFilterEditorSubmitHandlers
HasFinishedHandlers
HasFixedFacetValueChangedHandlers
HasFocusChangedHandlers
HasFocusHandlers
HasFolderClickHandlers
HasFolderClosedHandlers
HasFolderContextClickHandlers
HasFolderDropHandlers
HasFolderOpenedHandlers
HasFormItemClickHandlers
HasFormSubmitFailedHandlers
HasFormulaUpdatedHandlers
HasGradientChangedHandlers
HasGroupByCompleteHandlers
HasGroupByHandlers
HasGroupStateChangedHandlers
HasGroupTreeChangedHandlers
HashAlgorithm
Algorithms to use when hashing field values (see `DataSourceField.storeWithHash`).
HasHandleErrorHandlers
HasHeaderClickHandlers
HasHeaderDoubleClickHandlers
HasHeaderHoverHandlers
HasHiddenValidationErrorsHandlers
HasHilitesChangedHandlers
HasHoverHandlers
HasHoverHiddenHandlers
HasIconClickHandlers
HasIconClickHandlers
HasIconKeyPressHandlers
HasImageClickHandlers
HasIndicatorClickHandlers
HasItemChangedHandlers
HasItemChangeHandlers
HasItemClickHandlers
HasItemClickHandlers
HasItemDragResizedHandlers
HasItemHoverHandlers
HasItemKeyPressHandlers
HasKeyDownHandlers
HasKeyDownHandlers
HasKeyPressHandlers
HasKeyPressHandlers
HasKeyUpHandlers
HasLaneFieldClickHandlers
HasLeafClickHandlers
HasLeafContextClickHandlers
HasLegendClickHandlers
HasLegendHoverHandlers
HasListPropertiesChangedHandlers
HasMaximizeClickHandlers
HasMembersChangedHandlers
HasMemberSynchronizedHandlers
HasMenuIconClickHandlers
HasMinimizeClickHandlers
HasMouseDownHandlers
HasMouseDownHandlers
HasMouseMoveHandlers
HasMouseMoveHandlers
HasMouseOutHandlers
HasMouseOutHandlers
HasMouseOverHandlers
HasMouseOverHandlers
HasMouseStillDownHandlers
HasMouseUpHandlers
HasMouseUpHandlers
HasMouseWheelHandlers
HasMovedHandlers
HasMovedHandlers
HasNavigationClickHandlers
HasNodeAddedHandlers
HasNodeClickHandlers
HasNodeContextClickHandlers
HasNodeSelectedHandlers
HasOnSearchHandlers
HasOtherWindowsChangedHandlers
HasPaneChangedHandlers
HasParentMovedHandlers
HasPendingStatusChangedHandlers
HasPercentChangedHandlers
HasPickerColorSelectedHandlers
HasPickerIconClickHandlers
HasPreviewShownHandlers
HasRangeChangedEventHandlers
HasReadOnlyDisplayChangedHandlers
HasRecordClickHandlers
HasRecordClickHandlers
HasRecordCollapseHandlers
HasRecordContextClickHandlers
HasRecordDoubleClickHandlers
HasRecordDoubleClickHandlers
HasRecordDropHandlers
HasRecordExpandHandlers
HasRecordNavigationClickHandlers
HasRegroupHandlers
HasRemoveRecordClickHandlers
HasResizedHandlers
HasResizedHandlers
HasRestoreClickHandlers
HasRightMouseDownHandlers
HasRowContextClickHandlers
HasRowEditorEnterHandlers
HasRowEditorExitHandlers
HasRowHoverHandlers
HasRowMouseDownHandlers
HasRowMouseUpHandlers
HasRowOutHandlers
HasRowOverHandlers
HasRuleContextChangedHandlers
HasScrolledHandlers
HasSearchHandlers
HasSectionHeaderClickHandlers
HasSectionHeaderTitleHoverHandlers
HasSelectedEditNodesUpdatedHandlers
HasSelectionChangedHandlers
HasSelectionChangedHandlers
HasSelectionUpdatedHandlers
HasSetSortHandlers
HasShowContextMenuHandlers
HasShowContextMenuHandlers
HasShowContextMenuHandlers
HasShowValueHandlers
HasSortByFacetIdHandlers
HasSortByFacetValuesHandlers
HasSortChangedHandlers
HasSorterClickHandlers
HasSorterContextClickHandlers
HasSubmitValuesHandlers
HasTabContextMenuHandlers
HasTabDeselectedHandlers
HasTabIconClickHandlers
HasTabSelectedHandlers
HasTabsReorderedHandlers
HasTabTitleChangedHandlers
HasTimeChangedHandlers
HasTitleClickHandlers
HasTitleDoubleClickHandlers
HasTitleHoverHandlers
HasTitleHoverHandlers
HasToggleValueChangedHandlers
HasTraceElementHandlers
HasUpClickHandlers
HasValueChangedHandlers
HasValueClickHandlers
HasValueHoverHandlers
HasValueIconClickHandlers
HasValueIconClickHandlers
HasValuesChangedHandlers
HasValuesChangedHandlers
HasViewStateChangedHandlers
HasVisibilityChangedHandlers
HasZoneClickHandlers
HasZoomChangedHandlers
HbBeans
Beans and the DSRequest / DSResponse
HeaderClickEvent
HeaderClickHandler
HeaderControl
Convenience class for icons that are placed in as header controls in a `Window` Header, or `SectionStackSection`.
HeaderControl.HeaderIcon
HeaderControls
HeaderDoubleClickEvent
HeaderDoubleClickHandler
HeaderHoverEvent
HeaderHoverFormatter
Formatter object for providing a custom implementation of `ListGrid.headerHoverHTML(int,java.lang.String)`.
HeaderHoverHandler
HeaderItem
FormItem for showing a header within a DynamicForm.
HeaderLevel
Defines one level of headers shown above the event area in a `Timeline`.
HeaderLevelHoverCustomizer
Called to determine the hover text for a given span in a HeaderLevel in Timeline views
HeaderLevelTitleCustomizer
Called to determine the Title text for a given span in a HeaderLevel in Timeline views
HeaderMenuButton
The following APIs are all related to HeaderMenuButton.
HeaderSpan
The following APIs are all related to HeaderSpan.
HeaderSpan
A header span appears as a second level of headers in a ListGrid, spanning one or more ListGrid columns and their associated headers.
HibernateIntegration
Integration with Hibernate
HiddenItem
HiddenItems track a value but have no visible appearance and do not take up space in the form layout.
HiddenPalette
A Palette with no visible representation that handles programmatic creation of components.
HiddenValidationErrorsEvent
HiddenValidationErrorsHandler
HideSectionCallback
Hilite
An object representing a user-created and user-modifiable hilite, which can be created and edited with a `HiliteEditor` either directly or via the `ListGrid.canEditHilites` behavior.
HiliteEditor
A widget for defining and editing a set of `hilite rules` for use by `dataBoundComponents`.
HiliteEditorLogicalStructure
HiliteIconPosition
Where a `hilite icon` will be placed relative to normal cell content.
HiliteRule
A widget for editing the criteria of a single `DataBoundComponent` hilite.
HiliteRuleLogicalStructure
HilitesChangedEvent
HilitesChangedHandler
HiliteViaAIProgressDialog
HiliteViaAIProgressDialogLogicalStructure
HiliteViaAIResult
The result of a hilite-via-AI operation.
HiliteViaAIResultCallback
HiliteViaAISettings
Settings to use for hiliting a `DataBoundComponent` via AI.
Hiliting
Hiliting
HistogramChart
The following APIs are all related to HistogramChart.
HLayout
A subclass of Layout that applies a sizing policy along the horizontal axis, interpreting percent and "*" sizes as proportions of the width of the layout.
HLayoutLogicalStructure
HoopSelectionStyle
Hoop selection modes.
Hover
Utility methods related to hover / tooltips / prompts.
Hover
The Hover class handles showing a simple Smart GWT canvas containing arbitrary HTML, or triggering some other action in response to a user holding the mouse-pointer (or hovering) over a specific widget.
HoverComponents
The following APIs are all related to HoverComponents.
HoverCustomizer
Hover customizer object for returning custom HTML to display in a hover prompt for ListGrid cells
HoverEvent
HoverHandler
HoverHiddenEvent
HoverHiddenHandler
HoverHTMLCustomizer
Called to determine the hover HTML.
HoverMode
When `canHover` and `showHoverComponents` are both true, HoverMode dictates the type of UI to be displayed when a user hovers over a row or cell.
HoverPersistMode
Customizes how users can interact with hovers.
Hovers
The following APIs are all related to Hovers.
HStack
A subclass of Layout that simply stacks members on the horizontal axis without trying to manage their width.
HStackLogicalStructure
HTML
A synonym for `HTMLString`.
HtmlElement
The following APIs are all related to HtmlElement.
HTMLFlow
Use the HTMLFlow component to display HTML content that should expand to its natural size without scrolling.
HTMLFlowLogicalStructure
HTMLPane
Subclass of `HTMLFlow` configured to display HTML content in a pane of specified size.
HTMLPaneLogicalStructure
HTMLString
A String of HTML, such as "text".
I18n
Internationalization and Localization
I18nUtil
IButton
The IButton widget class is a class that implements the same APIs as the `Button` class.
IButtonLogicalStructure
Icon
The following APIs are all related to Icon.
IconButton
A simple subclass of `RibbonButton`.
IconButtonLogicalStructure
IconClickEvent
IconClickEvent
IconClickHandler
IconClickHandler
IconKeyPressEvent
IconKeyPressHandler
IconMenuButton
A simple subclass of `RibbonMenuButton`.
IconMenuButtonLogicalStructure
IconOverTrigger
Property to govern when the 'over' styling is applied to a formItemIcon.
Identifier
A string which is a valid Java and JavaScript identifier, as specified by ECMA-262 Section 7.6.
Identity
The following APIs are all related to Identity.
IDManager
IEFilters
Internet Explorer "filter" effects
Image
Utilities to render images
ImageClickEvent
ImageClickHandler
ImageColumns
Columns that show images either as their only appearance or in addition to text.
ImageEdges
The following APIs are all related to ImageEdges.
ImageEdgeStyles
The following APIs are all related to ImageEdgeStyles.
Images
Referring to and loading images.
ImageStyle
IMenuButton
IMenuButton based version of the `MenuButton` class.
IMenuButtonLogicalStructure
Img
The Img widget class implements a simple widget that displays a single image.
ImgButton
A Img that behaves like a button, going through up/down/over state transitions in response to user events.
ImgButtonLogicalStructure
ImgEditProxy
`EditProxy` that handles `Img` objects when editMode is enabled.
ImgHTMLProperties
A set of properties that define settings for use in image HTML.
ImgLogicalStructure
ImgProperties
A set of properties that can be used to create an image.
ImgSectionHeader
SectionHeader class based on an HLayout with `StretchImg` background.
ImgSectionHeaderLogicalStructure
ImgSplitbar
Resize bar for use in `Layouts`, based on the `Img` class.
ImgSplitbarLogicalStructure
ImgTab
Specialized StretchImgButton used by TabSet/TabBar for tabs
ImgTabLogicalStructure
ImportFormat
IncludeViaAndDomainKey
Using `includeVia` with Composite Keys and domainKey
IncludeViaSyntax
`includeVia` syntax
IndicatorCanvas
A subclass of `EventCanvas`, used to render `indicator lines` at important points in `calendar views`.
IndicatorCanvasLogicalStructure
IndicatorClick
IndicatorClickHandler
IndicatorHoverHTMLCustomizer
Called to determine the hover HTML to be displayed when the user hovers over an IndicatorCanvas in a calendar.
InlineEditEvent
Event that will trigger inline editing.
InlineFormItems
The following APIs are all related to InlineFormItems.
InSetValidator
Tests whether the value for this field matches any value from an arbitrary list of acceptable values.
IntegerItem
FormItem intended for inputting integer numbers.
IntegerRangeValidator
Tests whether the value for this field is a whole number within the range specified by validator.min and validator.max.
IntegerValueType
IntegratingAI
Integrating AI Technology
InterfaceArrayValueType<ComponentType>
InterfaceValueType<ValueType>
IPickTreeItem
Subclass of `PickTreeItem` which shows an `IMenuButton` rather than a simple `MenuButton` as it's main button.
IsBooleanValidator
Validation will fail if this field is non-empty and has a non-boolean value.
IscServer
Smart GWT Server Summary
IsFloatValidator
Tests whether the value for this field is a valid floating point number.
IsIntegerValidator
Tests whether the value for this field is a whole number.
IsOneOfValidator
Tests whether the value for this field matches any value from an arbitrary list of acceptable values.
IsStringValidator
Validation will fail if the value is not a string value.
ItemChangedEvent
ItemChangedHandler
ItemChangeEvent
ItemChangeHandler
ItemClickEvent
ItemClickEvent
ItemClickHandler
ItemClickHandler
ItemDragResizedHandler
ItemHoverEvent
ItemHoverHandler
ItemKeyPressEvent
ItemKeyPressHandler
ItemResizedEvent
Items
The following APIs are all related to Items.
JavaModuleDependencies
Java Module Dependencies
JavaScriptToJavaConversion
Converting JavaScript objects to Java
JavaToJavaScriptConversion
Converting GWT Java objects to JavaScript
JoinType
The type of join to make between two SQL tables when resolving `includeFrom` fields.
JpaHibernateRelations
JPA & Hibernate Relations
JpaIntegration
Integration with JPA
JsObject
JSOHelper
Utility class containing many useful static helper methods.
JSON
Utilities for working with JSON data.
JSONCircularReferenceMode
What the `JSONEncoder` should do when it encounters a circular reference in an object structure.
JSONDateFormat
Format for encoding dates in JSON.
JSONEncoder
Class for encoding objects as JSON strings.
JSONInstanceSerializationMode
Controls the output of the JSONEncoder when instances of Smart GWT classes (eg a ListGrid) are included in the data to be serialized.
JsoValueType<ValueType extends JavaScriptObject>
JsoWrapperValueType<ValueType>
JSSyntaxHiliter
Regular expression-based source code colorizer for JS source.
JUnitWebDriver
JUnit + Selenium WebDriver
KeyboardEvents
Keyboard Events
KeyCallback
KeyDownEvent
KeyDownEvent
KeyDownHandler
KeyDownHandler
KeyIdentifier
Identifier for a key pressed by the user, optionally specifying whether the Shift, Control, and/or Alt keys should be held or not held when the key is pressed, used by various methods.
KeyName
Strings to identify the various keys on the keyboard.
KeyNames
KeyPressEvent
KeyPressEvent
KeyPressHandler
KeyPressHandler
KeyRegistry
The following APIs are all related to KeyRegistry.
KeyUpEvent
KeyUpHandler
KnobType
Entries for the `DrawItem.knobs` array.
Label
Labels display a small amount of `alignable` `text` with optional `icon` and `autoFit`.
LabelAlignment
LabelCollapseMode
Strategy to apply when there is too little room for labels to be shown for all data points with comfortable padding (`FacetChart.minLabelGap`).
LabelEditProxy
`EditProxy` that handles `Label` objects when editMode is enabled.
LabelLogicalStructure
LabelRotationMode
Strategy for determining whether and when to rotate certain labels.
Labels
The following APIs are all related to Labels.
LabelsAndTitles
The following APIs are all related to LabelsAndTitles.
Lane
Lane shown in a `Timeline` view, or in a `day view` when `showDayLanes` is true.
LaneFieldClickEvent
LaneFieldClickHandler
Layout
The following APIs are all related to Layout.
Layout
Arranges a set of "member" Canvases in horizontal or vertical stacks, applying a layout policy to determine member heights and widths.
LayoutEditProxy
`EditProxy` that handles `Layout` objects when editMode is enabled.
LayoutLogicalStructure
LayoutMargin
The following APIs are all related to LayoutMargin.
LayoutMember
Properties that can be set on members of a layout to control how the layout is done
LayoutPolicy
The following APIs are all related to LayoutPolicy.
LayoutPolicy
Policy controlling how the Layout will manage member sizes on this axis.
LayoutResizeBarPolicy
Policy for whether resize bars are shown on members by default.
LayoutSpacer
Add a spacer to a `Layout` that takes up space just like a normal member, without actually drawing anything.
LayoutSpacerLogicalStructure
LeafClickEvent
LeafClickHandler
LeafContextClickEvent
LeafContextClickHandler
Legend
The following APIs are all related to Legend.
LegendAlign
Supported positioning of the chart Legend.
LegendClickEvent
LegendClickHandler
LegendHoverCustomizer
LegendHoverEvent
LegendHoverHandler
LengthRangeValidator
This validator type applies to string values only.
Lifecycle
The following APIs are all related to Lifecycle.
Line
The following APIs are all related to Line.
LinearGradient
Definition of a linear gradient between two points, (`x1`, `y1`) and (`x2`, `y2`).
LineBreakStyle
The style of line-breaks to use when exporting data
LineCap
Supported styles of drawing the endpoints of a line
LinePattern
Supported styles of drawing lines.
LineToCommand
Command to draw a multi-segment line.
LineWidthMapper
LinkDataFetchMode
LinkItem
A form item that displays a URL.
ListGrid
A ListGrid is a `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.
ListGridComponent
Standard component-type displayed within a ListGrid, as contained by `ListGrid.gridComponents`.
ListGridEditEvent
Event that will trigger inline editing.
ListGridEditorContext
Context object holding information about the cell being edited as part of a listGrid edit event.
ListGridEditorCustomizer
Customizer for the edit FormItem shown in a ListGrid cell
ListGridField
An ordinary JavaScript object containing properties that configures the display of and interaction with the columns of a `ListGrid`.
ListGridFieldIfFunction
ListGridFieldState
An object containing the stored presentation information for the fields of a listGrid.
ListGridFieldType
ListGrids format data for viewing and editing based on the type attribute of the field.
ListGridGroupState
An object containing the stored grouping information for a listGrid.
ListGridLogicalStructure
ListGridRecord
ListGridRecord represents a JavaScript Object whose properties contain values for each `ListGridField`.
ListGridRemoveField
ListGridSelectedState
An object containing the stored selection information for a listGrid.
ListGridSortState
An object containing the stored sort information for a listGrid.
ListGridSummaryField
This class represents a List Grid field that is used as a Summary Field.
ListGridUserCriteriaState
An object containing the stored criteria as applied by the user.
ListGridViewState
An object containing the "view state" information for a listGrid.
ListGridViewStatePart
ListPalette
A ListGrid that implements the `Palette` behavior, so it can be used as the source for drag and drop instantiation of components when combined with an `EditContext` as the drop target.
ListPaletteLogicalStructure
ListProperties
Configuration of an HTML list in a `RichTextEditor`.
ListPropertiesChangedEvent
ListPropertiesChangedHandler
ListPropertiesDialog
Dialog shown for editing properties of HTML lists in a `RichTextEditor`.
ListPropertiesDialogLogicalStructure
ListPropertiesPane
Pane containing controls for editing the style of HTML lists in a `RichTextEditor`.
ListPropertiesPaneLogicalStructure
ListStyleType
The style of list item marker for a list.
LoadAssemblyTag
<isomorphic:loadAssembly>
LoadingDataMessage
LoadingIndicator
The following APIs are all related to LoadingIndicator.
LoadingOptionalModules
Loading Optional Modules
LoadProjectCallback
LoadProjectErrorStatus
LoadProjectSettings
LoadProjectSettings is the bundle of settings that can be passed to loadProject() as the "settings" argument, including optional http parameters for the request to `ProjectLoaderServlet`.
LoadProjectTag
<isomorphic:loadProject>
LoadScreenCallback
LoadScreenSettings
This is the bundle of settings that can be passed to `RPCManager.loadScreen()` as the "settings" argument.
LoadState
The following APIs are all related to LoadState.
LoadState
Trees that dynamically load nodes keep track of whether each node has loaded its children.
LocalizedNumberFormatting
Localized Number Formatting
Location
The following APIs are all related to Location.
LocatorStrategy
The AutoTest subsystem relies on generating and parsing identifier strings to identify components on the page.
LocatorTypeStrategy
When attempting to identify a component from within a list of possible candidates as described `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.
LoggingMigration
Logging migration
LogicalDate
LogicalDate_CustomFieldSerializer
LogicalOperator
Operators that can evaluate a set of criteria and produce a combined result.
LogicalStructure
SmartGWT classes implementing
LogicalStructureObject
LogicalTime
LogicalTime_CustomFieldSerializer
LoginRequiredCallback
LogOutTask
Logs out the current user by opening the `Auth.logOutURL` in another tab or window.
LogPriority
Priority levels for log messages.
LogUtil
LongEvents
When events fill a day or span multiple days, it becomes impractical to view and interact with them in normal Calendar views.
LongValueType
Mail
The following APIs are all related to Mail.
Mail
A `Mail` object describes an email that will be sent automatically by the Smart GWT Server as part of a normal `DataSource` operation.
MakeQueryDataQuestionStep
MakeQueryDataQuestionStepResult
ManualJpaHibernate
Manual JPA & Hibernate Integration
MaskValidator
Validate against a regular expression mask, specified as validator.mask.
MatchElementSizeMode
How should a canvas match its target `Canvas.htmlElement` size?
MatchesFieldValidator
Tests whether the value for this field matches the value of some other field.
MavenSupport
Maven Support
MaximizeClickEvent
MaximizeClickHandler
MaxStackDismissMode
Media
The following APIs are all related to Media.
Members
The following APIs are all related to Members.
MembersChangedEvent
MembersChangedHandler
MemberSynchronizedEvent
MemberSynchronizedHandler
MemoryLeaks
Memory Leaks
Menu
The following APIs are all related to Menu.
Menu
The Menu widget class implements interactive menu widgets, with optional icons, submenus, and shortcut keys.
MenuBar
A MenuBar is a bar of buttons used to show a set of menus.
MenuBarLogicalStructure
MenuBasic
The following APIs are all related to MenuBasic.
MenuButton
Simple subclass of button associated with a menu widget (gets shown below the button).
MenuButtonLogicalStructure
MenuEditProxy
`EditProxy` that handles `MenuButton` and `MenuBar` objects when editMode is enabled.
MenuFieldID
Simple string identifiers for standard menu fields.
MenuIconClickEvent
MenuIconClickHandler
MenuIcons
The following APIs are all related to MenuIcons.
MenuItem
Object specifying an item in a `Menu`.
MenuItemClickEvent
MenuItemIfFunction
MenuItems
The following APIs are all related to MenuItems.
MenuItemSeparator
MenuItemStringFunction
MenuKeys
The following APIs are all related to MenuKeys.
MenuLogicalStructure
MenuPalette
A Menu that implements the `Palette` behavior, so it can be used as the source for drag and drop instantiation of components when combined with an `EditContext` as the drop target.
MenuPaletteLogicalStructure
MessageID
Messaging
Real-Time Messaging
Messaging
The Messaging class provides APIs to make use of SmartGWT Real-Time Messaging module, an optional module available with SmartGWT Power or Enterprise Edition which allows browser based web applications to publish and subscribe to HTTP Messaging channels, allowing the application to receive (and send) messages delivered via server push for "real-time" updates from the server without polling.
MessagingCallback
MessagingCallback
MessagingConnectionDownCallback
MessagingConnectionDownCallback
MessagingConnectionUpCallback
MessagingConnectionUpCallback
MetaBeanFactoryGenerator
MetricSettings
Defines a set of properties that are applicable to `additional value axes` of a `FacetChart`.
MiniDateRangeItem
Provides a compact interface for editing a date range, by providing a formatted, read-only display of the current selected date range with an icon to launch a `DateRangeDialog` to edit the range.
MinimalScrollbarContrastSuffix
Minimize
The following APIs are all related to Minimize.
MinimizeClickEvent
MinimizeClickHandler
MiniNavControl
Compact control for up/down navigation that roughly looks like an up arrowhead next to a down arrowhead.
MiniNavControlLogicalStructure
MobileDevelopment
Mobile Application Development
MockDataFormat
Specifies the format of the mock data.
MockDataSource
A special kind of `client-only DataSource` that can be configured with `"mock data"` - a simple text format for table or tree data.
MockDataType
Whether the mock data is for a flat grid-like dataset or for a tree.
MockDSExportCallback
MockDSExportFormat
MockDSExportSettings
Settings used to control the export or serialization of a `DataSource` by `Reify.getMockDS()`.
MockDSExportValidatorMode
Modal
The following APIs are all related to Modal.
MonthViewEvents
The following APIs are all related to MonthViewEvents.
MonthViewFormatting
The following APIs are all related to MonthViewFormatting.
MonthViewHoverHTMLCustomizer
Called to determine the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.
MouseDownEvent
MouseDownEvent
MouseDownHandler
MouseDownHandler
MouseEvents
The following APIs are all related to MouseEvents.
MouseMoveEvent
MouseMoveEvent
MouseMoveHandler
MouseMoveHandler
MouseOutEvent
MouseOutEvent
MouseOutHandler
MouseOutHandler
MouseOverEvent
MouseOverEvent
MouseOverHandler
MouseOverHandler
MouseStillDownEvent
MouseStillDownHandler
MouseUpEvent
MouseUpEvent
MouseUpHandler
MouseUpHandler
MouseWheelEvent
MouseWheelHandler
MovedEvent
MovedEvent
MovedHandler
MovedHandler
MoveKnobPoint
Specifies the starting point of a move knob with respect to its draw item.
MoveToCommand
Command to start a new sub-path.
MultiAutoChildren
A MultiAutoChild is an `com.smartgwt.client.types.AutoChild` where the creating component usually creates more than one, hence, unlike a normal AutoChild, the AutoChild is not accessible as `creator.[autoChildName]`.
MultiComboBoxItem
A MultiComboBoxItem is a combo box that allows the user to select multiple options.
MultiComboBoxLayoutStyle
Specifies the layout of the combo box and buttons in a MultiComboBoxItem.
MultiDecisionTask
Chooses a next element in a `Process` by evaluating a series of criteria against the `Process.state` and choosing the element associated with the criteria that matched, or a `defaultElement` if none of the criteria match.
MultiFileItem
The MultiFileItem provides an interface for a user to save one or more files that are related to a DataSource record, where each file is represented by a record in a related DataSource.
MultiFilePicker
The MultiFilePicker is a pop-up picker used by the `MultiFileItem` to allow the user to enter several files for upload.
MultiFilePickerLogicalStructure
MultiGroupDialog
A dialog that allows the user to set up complex grouping arrangements by defining a group of `GroupSpecifier`s.
MultiGroupDialogLogicalStructure
MultiGroupPanel
A widget that allows the user to set up complex grouping arrangements by defining a group of `GroupSpecifier`s.
MultiGroupPanelLogicalStructure
MultiInsertNonMatchingStrategy
For `SQLDataSource` only, the strategy to use to harmonize multiple records when `addData()` is called with a list of records, and `multiInsertStrategy` "multipleValues" is in force, and the supplied records do not all contain exactly the same fields.
MultiInsertStrategy
For `SQLDataSource` only, the strategy to use to insert multiple records when `addData()` is called with a list of records.
MultiLinkTree
The following APIs are all related to MultiLinkTree.
MultiMessageMode
MultiPickerItem
MultiPickerItem provides an interface to edit data involving whether a record has membership in a certain set, for example, where specific Employees are part of specific Teams.
MultiPickerSelectionStyle
Governs whether a `MultiPickerItem` displays selected and unselected option in a drop down pickList, or uses a `shuttle interface`
MultipleAppearance
Appearance for a SelectItem that allows multiple selection
MultipleField
The following APIs are all related to MultipleField.
MultipleFieldStorage
Options for how values are stored for a field that is `multiple:true`.
MultiSortCallback
Called when the user defines and accepts one or more SortSpecifiers in the `MultiSortDialog`.
MultiSortDialog
Deprecated.
In favor of `MultiSortDialog`, from the "widgets" packags
MultiSortDialog
A dialog that allows the user to set up complex sorting arrangements by defining a group of `SortSpecifier`s.
MultiSortDialogLogicalStructure
MultiSortPanel
A widget that allows the user to set up complex sorting arrangements by defining a group of `SortSpecifier`s.
MultiSortPanelLogicalStructure
MultiTenancy
Transparent Multi-Tenancy
MultiUpdatePolicy
Controls when primary keys are required for "update" and "remove" server operations, when allowMultiUpdate has not been explicitly configured on either the `operationBinding.allowMultiUpdate` or via the server-side API `DSRequest.setAllowMultiUpdate()`.
MultiWindow
Note: this is currently an experimental feature and not covered by normal support guarantees.
MultiWindowEvent
Various events triggered by any window in the current application.
MultiWindowEventCallback
MultiWindowSettings
Allows specifying settings to apply to the `MultiWindow` of a child window.
NativeCheckboxItem
A checkbox for manipulating 2-valued fields based on the native checkbox element.
NativeObject
Smart GWT debugging in Eclipse with logical structures
NavigateSplitPaneTask
Causes the list pane component to load data and update its title based on the current selection in the source pane.
NavigationBar
Navigation control implemented as a horizontal layout showing back and forward controls and a title.
NavigationBarControls
NavigationBarLogicalStructure
NavigationBarViewState
Encapsulates state of a `NavigationBar`'s view.
NavigationButton
Specially styled Button subclass used by the `NavigationBar` class.
NavigationButtonLogicalStructure
NavigationClickEvent
NavigationClickHandler
NavigationDirection
Navigation direction.
NavigationMethod
Method of, or reason for, navigation between panes.
NavigationMode
Controls the navigation mode of records.
NavItem
Properties for a navigation item in a `NavPanel`.
NavPanel
Provides a list or tree of `navigation items`, each of which specifies a component to be displayed in a mutually exclusive fashion in the `navDeck`.
NavPanelLogicalStructure
NetworkPerformance
Network Performance
NextValueHandler
NodeAddedEvent
NodeAddedHandler
NodeClickEvent
NodeClickHandler
NodeContextClickEvent
NodeContextClickHandler
NodeLocator
An object containing sufficient context to unambiguously identify a single node in the tree.
NodeSelectedEvent
NodeSelectedHandler
NoFrames
Don't Misuse Frames
NonJavaBackend
.NET, PHP, Serverless Integration
NonPrimitiveArrayValueType<ComponentType>
NotEqualValidator
Determine whether a value does not match a value specified via `value`.
Notify
Notify provides a means to display on-screen messages that are automatically dismissed after a configurable amount of time, as an alternative to `modal notification` dialogs that can lower end user productivity.
NotifyAction
Represents an action that's associated with a message.
NotifyActionCallback
NotifySettings
An object used to configure how messages shown by `Notify.addMessage()` are drawn and behave.
NotifyTransition
NotifyType
An identifier passed to `Notify` APIs to group related messages together so that they all use the same behavior and display settings.
NotInSetValidator
Tests whether the value for this field matches any value from an arbitrary list of acceptable values.
Npmjs
NPMJS Support
NullAccessType
The possible access types for records with a null `ownerIdField` (only applicable if `ownerIdField` is specified)
NumberUtil
Static singleton class containing APIs for interacting with Numbers.
NumberValueType<ValueType extends Number>
ObjectArrayValueType<ComponentType>
ObjectFactory
This class contains static utility methods to map between SmartClient objects/types and Smart GWT objects/classes.
ObtainingLocators
Obtaining locators
OdataDataSource
Server-side OData DataSource
Offline
The following APIs are all related to Offline.
Offline
The Offline class provides features for storing and retrieving values in persistent browser storage.
OfflineGroup
The following APIs are all related to OfflineGroup.
OnSearchEvent
OnSearchHandler
OpenapiSupport
OpenAPI Specification (OAS) Support
OpenFinWindow
Note: this is currently an experimental feature and not covered by normal support guarantees.
OperationBinding
An operationBinding tells a DataSource how to execute one of the basic DS operations: fetch, add, update, remove.
OperationBinding
An operationBinding tells a DataSource how to execute one of the basic DS operations: fetch, add, update, remove.
Operations
Operations Overview
Operator
Specification of an operator for use in filtering, for example "equals".
Operator
Specification of an operator for use in filtering, for example "equals".
OperatorId
An operator is used as part of a `Criterion` when specifying `AdvancedCriteria`.
OperatorValueType
Indicates the kind of value expected in a `Criterion` that uses this operator.
Orientation
The following APIs are all related to Orientation.
Orientation
OrientationChangeEvent
OrientationChangeHandler
OtherValueType<ValueType>
OtherWindowsChangedEvent
OtherWindowsChangedHandler
OutputWhen
The type of condition field must match in order to be fetched from underlying source of data and delivered the client.
Overflow
Page
Provides information about the page you're loaded in.
PageEvent
Events registerable via `Page.setEvent()`
PageKeyHandler
PageOrientation
Is this page being viewed in landscape or portrait orientation? Typically used with mobile devices.
Paging
The following APIs are all related to Paging.
Palette
An interface that provides the ability to create components from a `PaletteNode`.
PaletteNode
An object representing a component which the user may create dynamically within an application.
PaletteNodeCallback
PaneChangedEvent
PaneChangedHandler
PanelPlacement
The following APIs are all related to PanelPlacement.
PanelPlacement
Possible placements for pop-up choosers, menus, dialogs or other temporary UIs, which may need to expand to take up additional room for smaller screens.
ParentMovedEvent
ParentMovedHandler
PartialCommitOption
Action to take if a user attempts to save the dataset produced by a `BatchUploader` whilst it still contains errors.
PasswordItem
FormItem for password fields, where text input by the user should not be shown in readable text.
PastedValueTransformer
PatternOperators
The `search operators` use patterns like "foo*txt" to match text values.
PBooleanArrayValueType
PBooleanValueType
PDoubleArrayValueType
PDoubleValueType
PendingStatusChangedEvent
PendingStatusChangedHandler
PercentBoxModel
Determines sizing model when sizing / positioning a canvas relative to its `percentBox`.
PercentChangedEvent
PercentChangedHandler
PercentSizing
Canvas Percentage sizing
Performance
The following APIs are all related to Performance.
PFloatArrayValueType
PFloatValueType
PhonegapIntegration
Integration with PhoneGap
PickerColorSelectedEvent
PickerColorSelectedHandler
PickerIcon
The following APIs are all related to PickerIcon.
PickerIcon
Convenience class for setting pickers for form fields.
PickerIconClickEvent
PickerIconClickHandler
PickerIconName
Standard pickers
PickList
Properties and methods related to the pickList, which is the drop-down list of options that appears under a SelectItem or ComboBoxItem.
PickList
Interface to show a drop-down list of pickable options.
PickListItemIconPlacement
For PickList items with `PickListItemIconPlacement` set such that the pickList does not render near-origin, possible location for rendering formItemIcons.
PickListMenu
`ListGrid` subclass used, by default, by FormItems which implement PickList to display a flat list of selectable options.
PickListMenuLogicalStructure
PickTreeItem
FormItem that allows picking a value from a hierarchical data model.
PieChart
The following APIs are all related to PieChart.
PIntegerArrayValueType
PIntegerValueType
PlatformDependencies
Platform Dependencies
PlaybackCompleteCallback
PLongArrayValueType
PLongValueType
PluginBridges_DeprecatedEntryPoint
Point
X/Y position in pixels, specified as an Array with two members, for example: [30, 50]
PointerSettings
A set of properties that can be used to configure a `canvas pointer`.
PointerSettingsLogicalStructure
PointShape
Supported data point shapes for `FacetChart.pointShapes` are:
PortableAutoTests
Writing AutoTests for multiple environments
PortalLayout
A PortalLayout is a special subclass of Layout designed to display `Portlet` windows.
PortalLayoutDrop
Drag and Drop behavior within PortalLayouts
PortalLayoutLogicalStructure
PortalPosition
Represents the position of a `Portlet` within a `PortalLayout`, indicating the column, row, and position within the row.
Portlet
Custom subclass of Window configured to be embedded within a `PortalLayout`.
PortletLogicalStructure
Positioning
Horizontal and vertical location on the page
Positioning
PreserveOpenState
PresetCriteriaItem
A FormItem for use with the `FilterBuilder`, allows the user to pick from a set of pre-configured search criteria such as specific ranges in numeric or date data, and provide user friendly titles for such criteria, such as "within the next two weeks" or "High (0.75 - 0.99)".
PresetDateRangeItem
Allows the user to pick from pre-set date ranges or choose a custom date range via a `DateRangeDialog`.
PreviewShownEvent
PreviewShownHandler
PreviousValueHandler
PrintCanvas
PrintCanvas is a subclass of canvas which renders printable content HTML and provides APIs for printing this content as a separate document.
PrintCanvasCallback
PrintCanvasLogicalStructure
PrintCanvasTask
Print canvas by showing print preview.
PrintHTMLCallback
Print callback used by `Canvas.getPrintHTML(PrintProperties, PrintHTMLCallback)`
Printing
Printing
PrintPreviewCallback
PrintProperties
Settings for generating printable HTML for components.
PrintWindow
Subclass of `Window` used for displaying a printable view.
PrintWindowLogicalStructure
Process
A instance of Process represents a stateful process executing a series of Tasks, which may be: user interactions calls to DataSources (hence: any database or web service) arbitrary code other Processes A Process is stateful in the sense that it maintains `state` across the different tasks that are executed.
ProcessCallback
ProcessElement
A ProcessElement is an abstract superclass for elements involved in a `Process`, such as a `Task` or `DecisionTask`.
ProcessFinishedEvent
ProcessSequence
An Array of `ProcessElement`s involved in a `Process`.
ProcessTraceElementEvent
ProcessValueType
Progressbar
The Progressbar widget class extends the StretchImg class to implement image-based progress bars (graphical bars whose lengths represent percentages, typically of task completion).
ProgressbarEditProxy
`EditProxy` that handles `Progressbar` objects when editMode is enabled.
ProgressbarLogicalStructure
ProgressiveLoading
Progressive Loading
Project
Represents a `Reify` project loaded from the server via `RPCManager.loadProject()`.
PromiseOutcome
Holds information about the outcome of a settled Promise.
Prompt
The following APIs are all related to Prompt.
Prompting
Objects / methods used for displaying prompts and warnings to the user via (possibly modal) isc Dialog objects.
PromptStyle
PropertyIdentifier
A means of identifying the properties in an exported dataset - either the property name or its title.
PropertySheet
Editor with a minimalist appearance, tuned for editing large numbers of properties in a constrained space.
PropertySheetLogicalStructure
PropertyValue
Identifies a property name and value to be assigned to a component by the `SetPropertiesTask`.
ProportionalResizeMode
PseudoFieldGeneration
The following APIs are all related to PseudoFieldGeneration.
QualityIndicatedLocator
An object returned from `AutoTest.getLocatorWithIndicators()` that includes the locator and properties that describe the quality of the locator.
QuartzAdapters
Quartz DataSources
QueueSentCallback
RadarChart
The following APIs are all related to RadarChart.
RadialGradient
Definition of a radial gradient.
RadioGroupItem
FormItem that shows a set of mutually exclusive options as a group of radio buttons.
RangeChangedEventHandler
RangeSlider
A "double slider" allowing the user to select a range via two draggable thumbs.
RangeSliderLogicalStructure
ReadOnly
The following APIs are all related to ReadOnly.
ReadOnlyDisplayAppearance
Dictates the appearance of form items when `FormItem.canEdit` is set to `false`.
ReadOnlyDisplayChangedEvent
ReadOnlyDisplayChangedHandler
ReapplyAIFilterResponse
Represents the result of a request to re-evaluate an "aiFilter" `AdvancedCriteria` on a list of updated records.
RecategorizeMode
Type for controlling when a "recategorize" is applied to records being dropped on a databound component from another databound component.
Record
A Record contains attributes that are displayed and edited by a `DataBoundComponent`.
RecordClickEvent
RecordClickEvent
RecordClickHandler
RecordClickHandler
RecordCollapseEvent
RecordCollapseHandler
RecordComponentPoolingMode
The method of component-pooling to employ for `recordComponents`.
RecordComponents
The following APIs are all related to RecordComponents.
RecordContextClickEvent
RecordContextClickHandler
RecordDoubleClickEvent
RecordDoubleClickEvent
RecordDoubleClickHandler
RecordDoubleClickHandler
RecordDropAppearance
Controls how ListGrid record drop events report their `dropPosition`, and where the drop indicator will be displayed if appropriate.
RecordDropEvent
RecordDropHandler
RecordDropPosition
Position of a `ListGrid.recordDrop()` operation with respect to the target record.
RecordEditor
Component for editing a single record.
RecordEditors are implemented as a subclass of ListGrid, showing no header and a single row always drawn in the editable state, allowing the user to modify the values at any time.
RecordEditorLogicalStructure
RecordExpandEvent
RecordExpandHandler
RecordFormatter
RecordLayout
Controls the style of TableView record display
RecordList
An an ordered collection of Records.
RecordList.SortNormalizer
RecordNavigationClickEvent
RecordNavigationClickHandler
RecordSummaryFunction
Function to produce a summary value based on field values within a record.
RecordSummaryFunctionType
Function to produce a summary value based on field values within a record.
RecordType
Defines the various types of record that can be present in a `ListGrid`.
Rectangle
Rects
The following APIs are all related to Rects.
RefDataClass
Reflection
Registering Classes for Reflection
RegExpValidator
Regexp type validators will determine whether the value specified matches a given regular expression.
RegressionLineType
Supported regression algorithms for fitting the data points of a scatter plot.
RegroupEvent
RegroupHandler
Reify
Reify Overview
Reify
An application available within `Reify OnSite` that allows developers to create and manage Smart GWT screens and datasources.
ReifyAddWorkflowTask
Reify OnSite: Adding Custom Workflow Tasks
ReifyCustomComponents
Adding Custom Components to Reify
ReifyCustomDataSources
Adding Custom DataSources to Reify
ReifyForDevelopers
Reify for Developers
ReifyLogicalStructure
ReifyMaven
Importing from Reify
ReifyMessaging
Reify Messaging
ReifyOnSite
Reify OnSite
RelationPath
A simple object representing the path for navigation from source to target DataSources via foreign key declarations defined between each.
RelativeDate
This class is used used to specify a datetime offset within SmartGWT, for example for use in the `RelativeDateItem` class.
RelativeDateItem
A FormItem for entering a date relative to today or relative to some other date, or a specific absolute date.
RelativeDateRangePosition
When relative dates are specified in a date range, typically in a RelativeDateItem or DateRangeItem, in order to make the range inclusive or exclusive, it is useful to be able to specify whether we're referring to the start or end of the date in question.
RelativeDateShortcut
A RelativeDateShortcut is a special string that represents a shortcut to a date phrase that can be automatically mapped to a `RelativeDateString` for use in widgets that leverage relative-dates, such as the `RelativeDateItem`.
RelativeDateString
A string of known format used to specify a datetime offset.
ReliableLocators
Generating Reliable AutoTestLocators
Relogin
Relogin
RemoteDebugging
Remote Debugging
RemoteWindow
Note: this is currently an experimental feature and not covered by normal support guarantees.
RemoteWindowBooleanCallback
RemoteWindowCallback
RemoteWindowErrorCallback
RemoteWindowMapCallback
RemoveRecordClickEvent
RemoveRecordClickHandler
ReorderPosition
Controls where a drag-item should be dropped in relation to the target row
RequestTransformer
The RequestTransformer provides the equivalent functionality of overriding `DataSource.transformRequest(DSRequest)` when instantiating a DataSource on the client.
RequestTransformer
The RequestTransformer provides the equivalent functionality of overriding `RPCManager.transformRequest(RPCRequest)`.
RequiredIfFunction
RequiredIfValidator
RequiredIf type validators should be specified with a ``RequiredIfFunction``, which has to be passed to ``setExpression()``, and takes two parameters: item - the DynamicForm item on which the error occurred (may be null) value - the value of the field in question
ResetItem
Button that resets the form to default values, by calling `DynamicForm.resetValues()` If you define a click handler on this item, you can return false to cancel the reset.
ResetPasswordTask
Show user password reset dialog by opening the `Auth.resetPasswordURL` in another tab or window.
ResizedEvent
ResizedEvent
ResizedHandler
ResizedHandler
ResizeDirection
ResizeKnobPoint
Specifies the position of a resize knob with respect to its draw item.
Resizing
The following APIs are all related to Resizing.
ResponseTransformer
The ResponseTransformer provides the equivalent functionality of overriding `DataSource.transformResponse(DSResponse, DSRequest, Object)` } when instantiating a DataSource on the client.
RESTAuthentication
Authentication settings, applicable only to the `RestConnector`
RESTAuthenticationType
Enumeration of the supported authentication types for the `RestConnector` implementation.
RestDataSource
NOTE: This article discusses Smart GWT's client-side REST client implementation.
RestoreClickEvent
RestoreClickHandler
RESTRequestFormat
Indicates the request format to be used for a REST operation.
RESTResponseFormat
Indicates the response format to be used for a REST operation.
ResultSet
ResultSets are an implementation of the `com.smartgwt.client.data.List` interface that automatically fetches DataSource records when items are requested from the List.
ResultTree
ResultTrees are an implementation of the `Tree` API, used to handle hierarchical data, whose nodes are DataSource records which are retrieved from a server.
RibbonBar
A `ToolStrip-based` class for showing `groups` of `RibbonButtons`s.
RibbonBarLogicalStructure
RibbonButton
A Button subclass that displays an `icon`, `title` and optional `menuIcon` and is capable of `horizontal and vertical` orientation.
RibbonButtonLogicalStructure
RibbonGroup
The following APIs are all related to RibbonGroup.
RibbonGroup
A widget that groups `RibbonButtons`s for use in `RibbonBars`.
RibbonGroupLogicalStructure
RibbonMenuButton
A simple subclass of `RibbonButton` that shows a menuIcon by default and implements showMenu().
RibbonMenuButtonLogicalStructure
RichTextEditor
RichTextEditing component.
RichTextEditorLogicalStructure
RichTextItem
FormItem for rich text (HTML) editing.
RightMouseDownEvent
RightMouseDownHandler
RowContextClickEvent
RowContextClickHandler
RowCountCallback
RowCountDisplay
The following APIs are all related to RowCountDisplay.
RowCountStatus
Enumerated status indicating whether a ResultSet has an accurate `ResultSet.getRowCount()` row count for the data set.
RowEditorEnterEvent
RowEditorEnterHandler
RowEditorExitEvent
RowEditorExitHandler
RowEffects
The following APIs are all related to RowEffects.
RowEndEditAction
While editing a ListGrid, what cell should we edit when the user attempts to navigate into a cell past the end of an editable row, via a Tab keypress, or a programmatic saveAndEditNextCell() call?
RowHoverEvent
RowHoverHandler
RowMouseDownEvent
RowMouseDownHandler
RowMouseUpEvent
RowMouseUpHandler
RowNumberField
The following APIs are all related to RowNumberField.
RowOutEvent
RowOutHandler
RowOverEvent
RowOverHandler
RowRangeDisplay
Grid row-range and row-count display
RowRangeDisplay
Specialized `Label` for showing the currently visible row range and row count for a source listGrid.
RowRangeDisplayLogicalStructure
RowRangeDisplayStyle
Governs how `ListGrid.getRowRangeDisplayValue()` formats the row range and row count for display
RowSpacerItem
Form item that renders as a blank row in the form layout.
Set `startRow` to `false` to create a rowSpacer that simply takes up every remaining column in the current row rather than starting a new row.
RowSpanEditMode
When `ListGrid.allowRowSpanning` is enabled, certain cells may span multiple rows.
RowSpanSelectionMode
Behavior of selection when row spanning is active.
RPCCallback
RPCManager
RPCManager is a static singleton class that manages transparent client/server RPC (remote procedure call).
RpcPrompt
The properties in this group all deal with setting and styling a modal prompt during an RPC call to the server.
RPCQueueCallback
RPCRequest
Encapsulates a client/server RPC request.
RPCResponse
Encapsulates an RPC response from the server.
RPCTransport
Smart GWT supports multiple RPC transports for maximum compatibility and feature richness.
RTL
The following APIs are all related to RTL.
RuleContextChangedEvent
RuleContextChangedHandler
RuleCriteria
Dynamic Rules
SafeSkinning
Safe Skinning
SavedSearchEditor
User Interface component allowing a user to add a new saved search or edit an existing search.
SavedSearchEditorLogicalStructure
SavedSearches
Data components such as `ListGrid` or `TileGrid` may allow users to set up their own search criteria within an application, either via an external `SearchForm`, or through built in UI such as the `ListGrid.filterEditor`.
SavedSearchItem
(SSI for short) Provides a UI for creating, editing and applying saved searches for a `target` using the `SavedSearches` system.
SavedSearchItemEditProxy
`EditProxy` that handles `SavedSearchItems` when editMode is enabled.
SavedSearchStoredState
What should be stored by a saved search?
SC
ScanMode
When discovering a tree, the scanMode determines how to scan for the childrenProperty "node": take each node individually "branch": scan direct siblings as a group, looking for best fit "level": scan entire tree levels as a group, looking for best fit
SCClassName
Name of a SmartGWT class, including framework classes such as "ListGrid", or custom subclasses you have created.
SCEE
Deprecated.
SchemaSet
A set of schema derived from the `<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)`.
SCImgURL
For properties that refer to images by URL, such as `Img.src` and `Button.icon`, Smart GWT provides various capabilities to allow for simpler and more uniform settings, and to allow applications to be restructured more easily.
SCPOWER
Deprecated.
SCPRO
Deprecated.
ScreenLoader
The ScreenLoader component can be used to load `ComponentXML Screens` into a running application.
ScreenLoaderLogicalStructure
ScriptTask
Task that executes arbitrary code, either synchronous or asynchronous.
Scroll
The following APIs are all related to Scroll.
Scrollbar
The Scrollbar widget implements cross-platform, image-based scrollbars that control the scrolling of content in other widgets.
ScrollbarLogicalStructure
ScrolledEvent
ScrolledHandler
Scrolling
Scrolling and clipping of objects when part of the object is obscured
ScrollingBehavior
Understanding scroll behavior
SCSpriteConfig
Using Sprites
SCStatefulImgConfig
A configuration object containing image URLs for a set of possible images to display based on the `state` of some components.
SdkInstall
Deploying the Smart GWT SDK
Search
The following APIs are all related to Search.
SearchCriteria
The following APIs are all related to SearchCriteria.
SearchEditorMode
Affects the appearance and behavior of the builtin `SavedSearchEditor`.
SearchForm
A SearchForm is a DynamicForm specialized for a user to enter search criteria.
SearchFormLogicalStructure
SearchHandler
SectionHeader
Simple SectionHeader class based on a Label with an icon, skinnable via CSS.
SectionHeaderClickEvent
SectionHeaderClickHandler
SectionHeaderLogicalStructure
SectionHeaderTitleHoverEvent
SectionHeaderTitleHoverHandler
SectionItem
Header item for a collapsible section in a `DynamicForm`.
SectionStack
A container that manages a list of sections of widgets, each with a header.
SectionStackEditProxy
`EditProxy` that handles `SectionStack` objects when editMode is enabled.
SectionStackLogicalStructure
SectionStackSection
Section descriptor used by a SectionStack to describe a section of items which are shown or hidden together along with their associated header.
SectionStackSectionEditProxy
`EditProxy` that handles `SectionStackSection` objects when editMode is enabled.
Selected
SelectedAppearance
Appearance when a component is in `edit mode` and is selected.
SelectedEditNodesUpdatedEvent
SelectedEditNodesUpdatedHandler
Selection
Selection
SelectionAppearance
How data selection should be presented to the user.
SelectionBoundary
Boundary type for limiting where contiguous selection (via shift+click or drag selection) can be applied across `facets` or `facetValues`.
SelectionChangedEvent
SelectionChangedHandler
SelectionChangedHandler
SelectionEvent
SelectionNotificationType
Enum to indicate selection change notification types.
SelectionOutline
This static singleton class implements a component that can be used to highlight any other Canvas or FormItem by drawing a line around it and optional label.
SelectionStyle
Different styles of selection that a list, etc.
SelectionTreeMenu
A simple subclass of `Menu` created by `TreeMenuButton`.
SelectionTreeMenuLogicalStructure
SelectionType
Controls how an object changes state when clicked
SelectionUpdatedEvent
SelectionUpdatedHandler
SelectItem
FormItem that allows picking between several mutually exclusive options via a select list.
SelectItemEditProxy
`EditProxy` that handles `SelectItems` and `ComboBoxItems` when editMode is enabled.
SelectItemsMode
Controls whether and when individual items are selected when clicking on a form in editMode.
SelectOtherItem
FormItem that shows a list of options, plus an "Other..." option that allows them to enter another value.
SeleneseRecorder
Note: this is currently an experimental feature and not covered by normal support guarantees.
SeleneseRecorderLogicalStructure
SeleneseSettings
Note: this is currently an experimental feature and not covered by normal support guarantees.
SeleniumCommand
Note: this is currently an experimental feature and not covered by normal support guarantees.
SendMethod
SendTransactionTask
Sends any currently queued DataSource operations, as a single transactional request to the server.
SequenceMode
The possible types of sequence handling Smart GWT Server can apply.
SerializationContext
SerializationSettings
Settings to control `EditContext` serialization.
Server_properties
`server.properties` file
ServerDataIntegration
Server DataSource Integration
ServerDataSourceImplementation
Notes on Server-side DataSource Implementations
ServerInit
Server Framework Initialization
ServerLogging
Server logging
ServerObject
The ServerObject tells the ISC server how to find or create a server-side object involved in `DMI` (Direct Method Invocation).
ServerRestConnector
Server-side REST Connector
ServerScript
Server Scripting
ServerSummaries
Server Summaries
ServiceTask
A ServiceTask is an element of a `Process` which calls a DataSource operation, optionally using part of the `process state` as inputs or storing outputs in the process state.
ServletDetails
The Core and Optional Smart GWT servlets
SetFilterItem
Specialized `MultiPickerItem` used for generating search criteria in the `FilterEditor` and in SearchForms.
SetPropertiesTask
Gets the value properties from a component and makes them available within the workflow as the `last task output`.
SetScreenDataTask
Sets an embedded screen's `dataContext` with the `dataContextBinding` evaluated in the scope of this task.
SetSortEvent
SetSortHandler
SetTitleTask
Sets the title of a tab, section, window, label, button, form control or facet chart.
SettledPromiseStatus
The eventual state of a settled Promise.
SgwtEEManualSetup
Manual Setup & Deployment of Smart GWT Pro/EE
SgwtEESetup
Smart GWT Pro/EE Project Setup
SGWTProperties
SGWTProperties
Shadow
The following APIs are all related to Shadow.
Shadow
A class used to define a shadow used in a Draw<Shape> Types.
SharingNodes
Sharing Nodes
ShiftFocusCallback
ShouldDisableCanvasCustomizer
ShowComponentTask
Show a currently hidden component.
ShowContextMenuEvent
ShowContextMenuEvent
ShowContextMenuEvent
ShowContextMenuHandler
ShowContextMenuHandler
ShowContextMenuHandler
ShowDataValuesMode
Strategy for determining whether and when to show `formatted text labels` for data-values.
ShowDateCustomizer
Called to determine whether a particular date should be visible in the passed view
ShowEventCustomizer
Called to determine whether a particular event should be visible in the passed view
ShowHideTask
Show or hide a component.
ShowLaneCustomizer
Called to determine a particular lane should be visible in the passed view
ShowMessageTask
Show an informational message and wait for the user to acknowledge.
ShowMessageType
Type of message to display in `ShowMessageTask`.
ShowNextToComponentTask
Show a component next to some other component.
ShowNotificationTask
Show a message which fades out automatically using `Notify`.
ShowSectionCallback
ShowValueEvent
ShowValueHandler
Shuttle
Shuttle-style selection component allowing uses to select records by moving them from a set of source records to a set of target records
ShuttleItem
`Shuttle`-based form item for choosing values from a list of options.
ShuttleLogicalStructure
Side
Side of a component.
SimpleGradient
Definition of a simple linear gradient defined by 2 colors and a `direction`.
SimpleNamesMode
Simple Names mode
SimpleTile
Default class used by a `TileGrid` to render each tile.
SimpleTileLogicalStructure
SimpleType
An atomic type such as a string or number, that is generally stored, displayed and manipulated as a single value.
SimpleType
An atomic type such as a string or number, that is generally stored, displayed and manipulated as a single value.
SimpleType.SimpleTypeValueComparator
SimpleType.SimpleTypeValueExtractor
SimpleType.SimpleTypeValueUpdater
SimpleTypeFormatter
Formatter for values of a `SimpleType`.
SimpleTypeParser
Parser for edited values of a `SimpleType`.
SingleSourceAIRequest
Represents a request to AI from a single `source` in some context.
Sizing
Width and height of an object
SkinEditor
Skin Editor
Skinning
Skinning / Theming
Skins
Skins are a collection of styles, images and other settings used to manage the overall appearance of an application.
SkipJSONValidation
Slider
The Slider class implements a GUI slider widget allowing the user to select a numeric value from within a range by dragging a visual indicator up and down a track.
SliderItem
FormItem that uses a `Slider` component to present an interface for picking from either a continuous range or a range with a small number of discrete values.
SliderLogicalStructure
SmartArchitecture
Smart GWT Architecture
SmartClientCypress
Integrating Smart GWT with Cypress
SmartClientPlaywright
Integrating Smart GWT with Playwright
SmartGwtDomainSyncLinker
Linker that inject domain sync Javascript to bypass same-origin policy restrictions on scripts deployed on different subdomains under the same parent domain (eg.
SmartGwtEntryPoint
Internal Smart GWT Entry point class where framework level initialization code executes before the users EntryPoint is run.
SmartGwtExceptionUtil
SmartGwtLinker
SmartGwtLinkerUtils
SmartGwtMessages
Interface to represent the messages contained in resource bundle: /Users/sjivan/java/smartgwt-svn/trunk/main/src/com/smartgwt/client/i18n/SmartGwtMessages.properties'.
SmartGwtMultiWinTypeSync
SmartGwtMultiWinTypeSync.NextSearchTarget
SmartGwtScriptInjector
SmartGwtSuperDevModeEntryPoint
SmartGwtTimer
`SmartGwtTimer` is an alternative to GWT's built-in `Timer` class that may allow code to be executed more efficiently.
Snapbar
Subclass of the `Splitbar` class that uses the `grip` functionality to show a stateful open / close indicator.
SnapbarLogicalStructure
SnapGridDragging
`Canvas.childrenSnapToGrid` and related properties, which causes snap-to-grid behavior during drag and drop.
SnapGridStyle
SnapPositioning
`Canvas.snapTo` and related properties for positioning widgets relative to other widgets edges and corners.
SortArrow
Do we display an arrow for the sorted field ?
SortByFacetIdEvent
SortByFacetIdHandler
SortByFacetValuesEvent
SortByFacetValuesHandler
SortChangedHandler
SortDirection
SorterClickEvent
SorterClickHandler
SorterContextClickEvent
SorterContextClickHandler
SortEvent
Sorting
The following APIs are all related to Sorting.
SortNormalizer
Sort Normalizer
SortNumeralHTMLCustomizer
This customizer is called to generate the HTML for the sortNumeral displayed next to a field's title when it is included in the current sort specification.
SortSpecifier
Class defining the details of a single sort operation
Sound
Smart GWT class for loading and playing audio files using the HTML5 <AUDIO> element.
SoundLogicalStructure
SpacerItem
A SpacerItem takes up a single cell in the FormLayout, of arbitrary size.
SpinnerItem
Item for picking a number.
Splitbar
Resize bar for use in `Layouts`, based on the `StretchImg` class.
SplitbarLogicalStructure
SplitPane
A device- and orientation-sensitive layout that implements the common pattern of rendering two panes side-by-side on desktop machines and on tablets in landscape orientation, while switching to showing a single pane for handset-sized devices or tablets in portrait orientation (this type of behavior is sometimes called "responsive design").
SplitPaneEditProxy
`EditProxy` that handles `SplitPane` objects when editMode is enabled.
SplitPaneLogicalStructure
SpringIntegration
Integration with Spring
SqlConnectionPooling
SQL Connection Pooling
SqlDataSource
SQL DataSources
SqlPaging
The following APIs are all related to SqlPaging.
SQLPagingStrategy
The technique Smart GWT Server's SQL DataSource should use to select a "page" of data from a table.
SqlSettings
SQL Database Settings in `server.properties`
SQLType
The types of custom query that can be handled by Smart GWT's built-in "sql" and "hibernate" DataSources.
SqlVsJPA
SQL DataSource vs JPA, EJB, MyBatis and other technologies
StackDirection
StackPersistence
StandaloneDataSourceUsage
Standalone DataSource Usage
StandardControlGroup
StartProcessTask
Task that executes another `Process` inside the current one.
StartTransactionTask
Starts queuing all DataSource operations so they can be sent to the server all together as a transaction.
State
Change of state and it's consequences for presentation.
State
Constants for the standard states for a StatefulCanvas.
StatefulCanvas
A component that has a set of possible states, and which presents itself differently according to which state it is in.
StatefulCanvasEditProxy
`EditProxy` that handles `StatefulCanvas` objects when editMode is enabled.
StatefulCanvasLogicalStructure
StatefulImages
Stateful Images
StateTask
StateTask can either copy fields of `Process.state` to other fields, or apply hardcoded values to `Process.state` via `value`.
StaticTextItem
A FormItem that displays an uneditable value.
Statistics
The following APIs are all related to Statistics.
StatusCodes
Status codes returned by the server as rpcResponse.status.
See the error handling doc section in `RPCManager` for more information on these codes
StockIcons
StockIcons Overview
StretchImg
The StretchImg widget class implements a widget type that displays a list of multiple images that make up a single image.
StretchImgButton
A StretchImg that behaves like a button, going through up/down/over state transitions in response to user events.
StretchImgButtonLogicalStructure
StretchImgLogicalStructure
StretchItem
An object representing one of the image segments displayed by a `StretchImg`.
StrictMode
Strict Mode
StringCountValidator
Determine whether a string value contains some substring multiple times.
StringMethod
A String containing a valid JavaScript expression that's automatically converted to a function with a return value matching the value of the last statement.
StringMethods
String Methods Overview
StringTemplateFunctions
String Template Functions
StringUtil
StringValueType
StyleGroup
An ordinary JavaScript object with properties that define an editable group of `settings` for use in `CSSEditor`s.
StyleSetting
An ordinary JavaScript object with properties that configure a setting for use in a `CSS-editor`.
SubmitItem
Button that saves the data in the form, by calling `DynamicForm.submit()` when clicked.
Submitting
Direct submission of forms to a target URL
SubmitValuesEvent
SubmitValuesHandler
SuggestRecordSummaryTitleResult
SummarizeRecordsResult
The result of a record summarization operation.
SummarizeValueExample
An example to provide to AI.
SummaryFunction
Function to produce a summary value based on an array of records and a field definition.
SummaryFunctionType
This is used for client-side or server-side summaries Client-side: Function to produce a summary value based on an array of records and a field definition.
SunNotice
Sun's java-engine implementation - Notice and Disclaimer
SVG
ISC Abstraction for SVG controls
SVGLogicalStructure
SvgSymbols
SVG Symbols Overview
SyntaxHiliter
Abstract base class for regular expression-based source code colorizer.
SystemAIRequest
Represents a programmer-specified request to AI in some context.
SystemDoneConfig
Configuration object for `AutoTest.isSystemDone()`.
SystemWaitConfig
Configuration object for `AutoTest.waitForSystemDone()`
Tab
Tab instances for use with `TabSet`.
TabBar
The following APIs are all related to TabBar.
TabBar
Shows a set of Tabs.
TabBarControls
The following APIs are all related to TabBarControls.
TabBarControls
TabBarLogicalStructure
TabBarScrolling
The following APIs are all related to TabBarScrolling.
TabClickEvent
TabCloseClickEvent
TabContextMenuEvent
TabContextMenuHandler
TabDeselectedEvent
TabDeselectedHandler
TabIconClickHandler
TabIndexManager
Singleton class with static APIs for managing automatically assigned tab order for Smart GWT components and other focusable elements.
TabIndexUpdatedCallback
TableLayout
The following APIs are all related to TableLayout.
TableMode
Controls the display mode of TableView record display
TableView
Shows a listing of records with one or more fields from each record, with built-in support for navigation and editing of lists of records.
TableViewLogicalStructure
TabName
An `Identifier` that must be locally unique within the containing `TabSet`.
TabOrderOverview
Tab Order Overview
TabSelectedEvent
TabSelectedHandler
TabSet
The TabSet class allows components on several panes to share the same space.
TabSetEditProxy
`EditProxy` that handles `TabSet` objects when editMode is enabled.
TabSetLogicalStructure
TabsReorderedEvent
TabsReorderedHandler
TabTitleChangedEvent
TabTitleChangedHandler
TabTitleEditEvent
An event that triggers title editing in a TabSet.
Task
A Task is an abstract superclass for `Process` and for all Task types that can be involved in a Process, such as a `ServiceTask`.
TaskDecision
Identifies a potential decision (branch) within a `MultiDecisionTask`.
TaskInputExpression
Task Input Expressions
TaskIO
Task Input / Output
TestData
Test Data
TestRunner
TestRunner
TextAreaItem
Class for editable multi-line text areas (uses HTML `<TEXTAREA>` object)
TextAreaItemEditProxy
`EditProxy` that handles `TextAreaItems` when editMode is enabled.
TextAreaWrap
TextDirection
Text Direction
TextExportSettings
Settings for use with `DataSource.recordsAsText()`.
TextImportSettings
Settings for use with `DataSource.recordsFromText()`.
TextItem
FormItem for managing a text field.
TextItemEditProxy
`EditProxy` that handles `TextItems` and `StaticTextItems` when editMode is enabled.
TextMatchStyle
For "fetch" operations, how simple search criteria should be interpreted for text fields (and to some extent numeric fields, see the notes below).
TextSettings
Common base class of `TextImportSettings`.
Thumb
The following APIs are all related to Thumb.
Ticks
The following APIs are all related to Ticks.
TieMode
what to do if there is more than one possible childrenProperty when using scanMode "branch" or "level" "node": continue, but pick childrenProperty on a per-node basis (will detect mixed) "highest": continue, picking the childrenProperty that occurred most as the single choice "stop": if there's a tie, stop at this level (assume no further children)
TileGrid
A TileGrid is a `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.
TileGridLogicalStructure
TileLayout
The following APIs are all related to TileLayout.
TileLayout
Lays out a series of components, called "tiles", in a grid with multiple tiles per row.
TileLayoutLogicalStructure
TileLayoutPolicy
Policy for laying out tiles.
TilePalette
A `TileGrid` that implements the `Palette` behavior, so it can be used as the source for drag and drop instantiation of components when combined with an `EditContext` as the drop target.
TilePaletteLogicalStructure
TileRecord
A TileRecord is a JavaScript Object whose properties contain values for each TileField.
TimeChangedEvent
TimeChangedHandler
TimeDisplayFormat
String designating a standard time format for displaying the times associated with dates strings.
TimeFormatter
Deprecated.
Use `DateDisplayFormatter` instead
TimeItem
A `FormItem` for editing `logical-time` values, which are Date instances where only the time-portion is relevant.
Timeline
Timeline is a trivial subclass of `Calendar` that configures the Calendar with settings typical for a standalone timeline view: hides the `day`, `week` and `month` tabs and the `controls bar` by default.
TimelineLogicalStructure
TimeUnit
An enum of time-units available for use with the `RelativeDateItem`, `TimeItem` and `Calendar` widgets.
TimingDataCallback
TitaniumIntegration
Integration with Titanium
Title
The following APIs are all related to Title.
TitleAlign
Supported positioning of the chart Title.
TitleAutoFitRotationMode
Strategy for determining how to place maximum-sized labels for `DrawItem.titleAutoFit`.
TitleClickEvent
TitleClickHandler
TitleDoubleClickEvent
TitleDoubleClickHandler
TitleFormatter
TitleHoverEvent
TitleHoverEvent
TitleHoverFormatter
TitleHoverHandler
TitleHoverHandler
TitleOrientation
Orientation of titles relative to the FormItem being labeled.
TitleRotationMode
The different ways in which the `titleLabel` of a `DrawItem` can be rotated with the item.
Titles
The following APIs are all related to Titles.
ToggleItem
FormItem that uses a `ToggleSwitch` component to present an interface for picking from either a continuous range or a range with a small number of discrete values.
ToggleSwitch
A simple control that presents a Boolean value as a toggle-switch, where the value can be toggled by clicking with the mouse, or with the Spacebar and left/right arrow-keys when `toggleOnKeypress` is true.
ToggleSwitchLogicalStructure
ToggleValueChangedEvent
ToggleValueChangedHandler
Toolbar
The following APIs are all related to Toolbar.
Toolbar
A Toolbar creates a vertical or horizontal strip of similar components (typically Buttons) and provides managed resizing and reordering behavior over those components.
ToolbarItem
Set of horizontally arranged buttons.
ToolbarItemEditProxy
`EditProxy` that handles `ToolbarItems` when editMode is enabled.
ToolbarLogicalStructure
ToolsDeployment
Tools Deployment
ToolStrip
Base class for creating toolstrips like those found in browsers and office applications: a mixed set of controls including `icon buttons`, `radio button groups`, `menus`, `comboBoxes`, `spacers`, `status displays` and `drop-down selects`.
ToolStripButton
Simple subclass of Button with appearance appropriate for a ToolStrip button.
ToolStripButtonLogicalStructure
ToolStripGroup
A simple subclass of `RibbonGroup`, which groups other controls for use in `ribbon-bars`.
ToolStripGroupLogicalStructure
ToolStripLogicalStructure
ToolStripMenuButton
Simple subclass of MenuButton with appearance appropriate for a ToolStrip menu button.
ToolStripMenuButtonLogicalStructure
ToolStripResizer
Simple subclass of ImgSplitbar with appearance appropriate for a ToolStrip resizer.
ToolStripResizerLogicalStructure
ToolStripSeparator
Simple subclass of Img with appearance appropriate for a ToolStrip separator
ToolStripSeparatorLogicalStructure
ToolStripSpacer
Simple subclass of LayoutSpacer with appearance appropriate for a ToolStrip spacer
ToolStripSpacerLogicalStructure
TopOperatorAppearance
Interface to use for showing and editing the `top-level operator` of a FilterBuilder.
Tour
The Tour class allows you to build tours and tutorials for end users, highlighting specific components on the page and prompting for specific user-interactions.
TourActionType
TourConfirmStep
Chooses one or another next process element based on confirmation of a message shown to user.
TourInputValidationMode
Policy for how `inputValidation` is performed for `actionType`:"change".
TourMode
TourStep
User task configuration for a step within a `Tour`.
TourWindow
A specific purpose Window class for showing individual steps in a tour.
TourWindowLogicalStructure
TraceElementHandler
Track
The following APIs are all related to Track.
TransactionChaining
Transaction Chaining
TransferImgButton
Convenience ImgButton subclass for various transfer icons typically used in a dual list for transferring items or reordering them within a list.
TransferImgButton.TransferImg
TransferNodesCallback
Called when the transferNodes() method completes.
TransferRecordsCallback
Called when the transferRecords() method completes.
Tree
A Tree is a data model representing a set of objects linked into a hierarchy.
TreeDataBinding
Tree DataBinding
TreeField
The following APIs are all related to TreeField.
TreeFilter
The following APIs are all related to TreeFilter.
TreeFilterMode
Mode for applying criteria to a tree.
TreeGrid
The Smart GWT system supports hierarchical data (also referred to as tree data due to its "branching" organization) with: the `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.
TreeGridDrop
TreeGrid drag and drop
TreeGridField
An object literal with a particular set of properties used to configure the display of and interaction with the columns of a `TreeGrid`.
TreeGridLogicalStructure
TreeGridOpenState
An object containing the open state for a treeGrid.
TreeGridViewState
An object containing the "view state" information for a treeGrid.
TreeIcons
The following APIs are all related to TreeIcons.
TreeMenuButton
Button used to display a hierarchical Menu group for representing / selecting tree data.
TreeMenuButtonLogicalStructure
TreeModelType
TreeNode
Every node in the tree is represented by a TreeNode object which is an object literal with a set of properties that configure the node.
TreePalette
A TreeGrid that implements the Palette behavior, so it can be used as the source for drag and drop instantiation of components when combined with an `EditContext` as the drop target.
TreePaletteLogicalStructure
TroubleshootingServerDeadlocks
Troubleshooting thread deadlocks on the server
Tutorial
The Tutorial class is a specialized version of the Tour class with `Tour.mode` set to "tutorial".
UnionDataSource
Union DataSources
UnionFieldsStrategy
The strategy used when auto-deriving the fields that make up a UnionDataSource, if no `unionFields` setting is provided.
UnsavedRecords
Handling Unsaved Records
UpClickEvent
UpClickHandler
UpdateTileCustomizer
Upload
Uploading Files
UploadItem
FormItem that creates an HTML <input type="file"> control, with an interface that allows a user to pick a file from his machine to upload to the server.
URI
A Uniform Resource Identifier string, as defined by https://tools.ietf.org/html/rfc3986.
URL
A Uniform Resource Locator string, as defined by https://www.w3.org/Addressing/URL/url-spec.html.
UserAIRequest
Represents a user-specified and user-modifiable request to AI in some context.
UserConfirmationGateway
Chooses one or another next process element based on confirmation of a message shown to user.
UserConfirmationTask
Chooses one or another next process element based on confirmation of a message shown to user.
UserFormula
An object representing a user-created formula.
UserSummary
An object representing a user-created summary.
UserTask
A task that involves showing a user interface to the end user allowing the user to view and input data and press a button (or do some other UI gesture) to complete the task.
UsingRPCTimingLogs
RPC timing logs
UsingSelenium
Using Selenium Scripts (Selenese)
ValidateDashboardComponentDataQuestionStep
ValidateDashboardComponentDataQuestionStepResult
ValidateQueryDataQuestionStep
Validation
Validation
ValidationMode
Mode of validation used for running validation on partially entered data.
ValidationStatusCallback
Validator
A validator describes a check that should be performed on a value the user is trying to save.
Validator
A validator describes a check that should be performed on a value the user is trying to save.
ValidatorActionCallback
ValidatorConditionCallback
ValidatorExecution
Explicitly defined validators on the dataSource field are run in the order in which they are defined on the client and on the server.
ValidatorType
Used to name a validator or reference a standard, built-in `Validator` - see list below.
ValueCallback
ValueChangedEvent
ValueChangedHandler
ValueClass
ValueClickEvent
ValueClickHandler
ValueEnum
ValueEnumValueType<ValueType extends Enum<ValueType> & ValueEnum>
ValueFormatter
ValueHoverEvent
ValueHoverHandler
ValueIconClickEvent
ValueIconClickEvent
ValueIconClickHandler
ValueIconClickHandler
ValueIconMapper
FormItem Value Icon mapper that allows the developer to specify the image source for an icon to be displayed for the current form item value.
ValueIcons
The following APIs are all related to ValueIcons.
ValueItemType
Enum used within the `FilterBuilder` class to indicate the role of a particular value-field form item within a filter clause.
ValueMap
A ValueMap defines the set of legal values for a field, and optionally allows you to provide a mapping from stored values to values as seen by the end user.
ValuesChangedEvent
ValuesChangedEvent
ValuesChangedHandler
ValuesChangedHandler
ValuesManager
The ValuesManager manages data from multiple member forms.
VelocityExpression
An expression in the Velocity Template Language (VTL).
VelocitySupport
Velocity context variables
Version
Class that returns meta information like version number, major version, minor version and build date.
VerticalAlignment
ViewFile
The following APIs are all related to ViewFile.
ViewFileItem
A simple subclass of `FileItem` for displaying the contents of "imageFile" fields in DynamicForms.
ViewLoader
The ViewLoader component can be used to load new Smart GWT-based user interfaces into a running application.
ViewLoaderLogicalStructure
ViewLoading
The following APIs are all related to ViewLoading.
ViewName
The names of the Calendar views.
ViewState
The following APIs are all related to ViewState.
ViewStateChangedEvent
ViewStateChangedHandler
Visibility
Whether an object can be seen
Visibility
VisibilityChangedEvent
VisibilityChangedHandler
VisibilityMode
Settings for whether multiple sections can be in the expanded state simultaneously.
VisibleMethod
Defines the method of the `ServerObject` if it appears in an `Application declaration file`.
VisualBuilder
Visual Builder
VLayout
A subclass of Layout that applies a sizing policy along the vertical axis, interpreting percent and "*" sizes as proportions of the height of the layout.
VLayoutLogicalStructure
VStack
A subclass of Layout that simply stacks members on the vertical axis without trying to manage their height.
VStackLogicalStructure
WaitForType
WaitingForAsyncActions
Waiting for asynchronous actions
WebService
Class representing a WebService definition derived from a WSDL file.
WebService
The following APIs are all related to WebService.
WebServiceCallback
WidgetCanvas
Window
A general purpose Window class for implementing dialogs, portlets, alerts, prompts, wizards and desktop-like windowing interfaces.
WindowEditProxy
`EditProxy` that handles `Window` objects when editMode is enabled.
WindowHeader
Window Header
WindowLogicalStructure
WindowMembers
The following APIs are all related to WindowMembers.
Workday
The following APIs are all related to Workday.
WriteCustomDataSource
Custom Server DataSources
WriteToGeneratedFields
Indicates the category of "generated fields" the Smart GWT Server should write values to, if defined on a `DSRequest` - see `writeToGeneratedFields`.
WSDataSource
A WSDataSource is a DataSource that is preconfigured to contact the WSDL web service built into the SDK (see isomorphic/system/schema/SmartClientOperations.wsdl).
WsdlBinding
WSDL Binding
WSDLLoadCallback
WSRequest
A WSRequest (or "web service request") is an extended RPCRequest will additional properties application to WSDL/SOAP web services.
XJSONDataSource
A DataSource preconfigured to use the `"scriptInclude"` transport (sometimes called "JSONP") for cross-domain calls to JSON services.
XmlClientVsServer
Server benefits - faster client-side processing Server neutral - heavy customization of XML transform, if any, written in Java Client benefits - faster server-side processing Client neutral - heavy customization of XML transform, if any, written in JavaScript
XmlCriteriaShorthand
All rules described in this topic are applied any time a property is of type `AdvancedCriteria` (in both Component XML and JavaScript component creation) and any API declares an `AdvancedCriteria` param.
XmlNamespaces
XmlSchema
The following APIs are all related to XmlSchema.
XmlSerialize
The following APIs are all related to XmlSerialize.
XMLSyntaxHiliter
Regular expression-based source code colorizer for XML source.
XmlTag
<isomorphic:XML>
XMLTools
Utility methods for dealing with XML elements, XML Schema, WSDL files, XSLT, and other XML-related functionality.
XmlTransform
The following APIs are all related to XmlTransform.
XORGateway
Chooses one or another next process element based on AdvancedCriteria applied to `Process.state`.
XPathExpression
A standard XPath expression as a string.
XSDLoadCallback
XssAndCSRFSecurity
XSS and CSRF Security
ZIndex
Object's "stacking order" above or below other objects
ZoneCanvas
A subclass of `EventCanvas`, used to render `styled areas` in `calendar views`.
ZoneCanvasLogicalStructure
ZoneClick
ZoneClickHandler
ZoneHoverHTMLCustomizer
Called to determine the hover HTML to be displayed when the user hovers over an ZoneCanvas in a calendar.
Zoom
The following APIs are all related to Zoom.
ZoomChangedEvent
ZoomChangedHandler
ZoomStartPosition