# Package com.smartgwt.client.types

package com.smartgwt.client.types

- Related Packages
  Package
  Description
  com.smartgwt.client
- Class
  Description
  AdminSearches
  Policy for choosing between admin searches fetched from the DataSource vs.
  AIContentType
  AIMessageSource
  AIProgressMessageCategory
  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.
  Alignment
  AnimationAcceleration
  Acceleration effect for animations.
  AnimationEffect
  String specifying effect to apply during an animated show or hide.
  AnimationLayoutMode
  During a `size animation`.
  ArrowKeyEditAction
  What to do if the user hits Up or Down arrow key while editing a cell.
  ArrowStyle
  Supported styles for arrowheads.
  AsyncOperationResultType
  The type of result of an asynchronous operation.
  AutoComplete
  AutoComplete behavior for `FormItems`.
  Autofit
  Possible values to change the behavior of how data will fill the ListGrid.
  AutoFitEvent
  Event on a listGrid header to trigger auto-fit of the listgrid field.
  AutoFitIconFieldType
  How should fields of `type:"icon"` be sized by default?
  AutoFitWidthApproach
  How should field width be determined when `ListGridField.autoFitWidth` is true?
  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.
  Axis
  An axis or "side" of a table.
  BackgroundRepeat
  BkgndRepeat
  BuildUIViaAIValidationType
  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`.
  CalendarSaveScenario
  Indicates how a given Calendar Save was initiated - values are dialog, editor and mouse.
  CanvasFilterMode
  Constants for use with `Canvas.getAllCanvases()` to specify which canvases to return.
  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`.
  CharacterCasing
  ChartType
  Known chart types.
  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
  ClickMaskMode
  Passed as a parameter to `Canvas.showClickMask()` to determine the masks behavior when clicked.
  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`.
  ColorPickerMode
  ConnectorOrientation
  Supported styles of connector orientations.
  ConnectorStyle
  Supported styles of connector styles.
  ContentLayoutPolicy
  Policy controlling how the window will manage content within its body.
  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.
  CriteriaCombineOperator
  The logical operator to use when combining criteria objects with the `DataSource.combineCriteria()` method.
  CriteriaPolicy
  CurrentPane
  Possible values for the current pane showing in a `SplitPane`.
  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.
  DataLineType
  Algorithms for drawing lines between points.
  DataPointSizeScalingMode
  The scaling mode used to map `FacetChart.pointSizeMetric` values to data point sizes.
  DataSourceTemplateReferenceMode
  Indicates the mode to use for resolving templated references in a DataSource's configuration file.
  DataURLFormat
  The data URL MIME type to use when `DrawPane.getDataURL()` is called to convert the drawing to a data URL.
  DateDisplayFormat
  Valid display formats for dates.
  DateEditingStyle
  The type of date/time editing style to use when editing an event.
  DateFieldLayout
  The direction in which an item should lay out it's fields.
  DateItemSelectorFormat
  Order of pickers and which pickers are present when using a DateItem with `DateItem.useTextField` false.
  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.
  DescriptionMode
  DeviceMode
  Possible layout modes for UI components that are sensitive to the device type being used (a.k.a.
  Direction
  DisplayNodeType
  Flag passed to functions as displayNodeType, telling the function whether it should work on folders, leaves or both at once.
  DragAppearance
  Different types of effects for showing dragging behavior.
  DragDataAction
  What do we do with data that's been dropped into another list?
  DragIntersectStyle
  Different styles of determining intersection: with mouse or entire rect of target
  DragMaskType
  What kind of mask to use for masking dragged element.
  DragTrackerMode
  When records are being dragged from within a ListGrid, what sort of drag-tracker should be displayed?
  DrawingType
  The type of drawing back-end used by a `DrawPane` to draw its `draw items` on screen.
  DrawPosition
  DrawShapeCommandType
  DSDataFormat
  Indicates the format to be used for HTTP requests and responses when fulfilling DSRequests (eg, when `DataSource.fetchData()` is called).
  DSInheritanceMode
  For DataSources of type "sql" and "hibernate", specifies the kind of inheritance to use when a dataSource specifies `inheritsFrom`.
  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`.
  DSServerType
  Indicates what Smart GWT Server will do with a DataSource request if you call dsRequest.execute() in server code.
  EdgeName
  An edge or corner of a rectange, or it's center.
  EditCompletionEvent
  What event / user interaction type caused cell editing to complete.
  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
  Encoding
  Form encoding types - these translate to Form ENCTYPE parameters.
  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.
  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()`.
  EventSchemaMode
  ExpansionComponentPoolingMode
  The method of pooling to employ for `expansionComponents`.
  ExpansionMode
  When `canExpandRecords` is true, ExpansionMode dictates the type of UI to be displayed in the expanded portion of the row.
  ExportDisplay
  Method to use for displaying the exported data.
  ExportFormat
  One of the supported formats for data-export.
  ExportImageFormat
  One of the supported formats for image export.
  FacetIndentDirection
  Specifies the direction of facet indenting for a `hierarchical` facet.
  FetchMode
  Mode of fetching records from the server.
  FieldAppearance
  FieldAuditMode
  FieldFilterMode
  Indicates where a given field can be legally filtered.
  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`
  FieldNamingStrategy
  The strategy to use when generating field names - for example, for new formula or summary fields created using the built-in editors.
  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).
  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.
  FireStyle
  Flags to set automatic removal of events from the page event registry.
  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.
  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.
  FormattingContext
  The context for which a data-value is being formatted.
  FormErrorOrientation
  FormItemElementType
  HTML elements that make up a complete FormItem (note, not all FormItems use all of these elements)
  FormItemType
  FormLayoutType
  FormMethod
  Form METHOD parameters - how the form fields are submitted to the server
  GroupStartOpen
  Possible values for the state of ListGrid groups when groupBy is called
  GroupTreeChangeType
  Type of change to the `ListGrid.groupTree`.
  HashAlgorithm
  Algorithms to use when hashing field values (see `DataSourceField.storeWithHash`).
  HeaderControls
  HiliteIconPosition
  Where a `hilite icon` will be placed relative to normal cell content.
  HoopSelectionStyle
  Hoop selection modes.
  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.
  IconOverTrigger
  Property to govern when the 'over' styling is applied to a formItemIcon.
  ImageStyle
  ImportFormat
  InlineEditEvent
  Event that will trigger inline editing.
  JoinType
  The type of join to make between two SQL tables when resolving `includeFrom` fields.
  JSONCircularReferenceMode
  What the `JSONEncoder` should do when it encounters a circular reference in an object structure.
  JSONDateFormat
  Format for encoding dates in JSON.
  JSONInstanceSerializationMode
  Controls the output of the JSONEncoder when instances of Smart GWT classes (eg a ListGrid) are included in the data to be serialized.
  KeyNames
  KnobType
  Entries for the `DrawItem.knobs` array.
  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`).
  LabelRotationMode
  Strategy for determining whether and when to rotate certain labels.
  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.
  LegendAlign
  Supported positioning of the chart Legend.
  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.
  LinkDataFetchMode
  ListGridComponent
  Standard component-type displayed within a ListGrid, as contained by `ListGrid.gridComponents`.
  ListGridEditEvent
  Event that will trigger inline editing.
  ListGridFieldType
  ListGrids format data for viewing and editing based on the type attribute of the field.
  ListGridViewStatePart
  ListStyleType
  The style of list item marker for a list.
  LoadProjectErrorStatus
  LoadState
  Trees that dynamically load nodes keep track of whether each node has loaded its children.
  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.
  LogicalOperator
  Operators that can evaluate a set of criteria and produce a combined result.
  LogPriority
  Priority levels for log messages.
  MatchElementSizeMode
  How should a canvas match its target `Canvas.htmlElement` size?
  MaxStackDismissMode
  MenuFieldID
  Simple string identifiers for standard menu fields.
  MinimalScrollbarContrastSuffix
  MockDataFormat
  Specifies the format of the mock data.
  MockDataType
  Whether the mock data is for a flat grid-like dataset or for a tree.
  MockDSExportFormat
  MockDSExportValidatorMode
  MoveKnobPoint
  Specifies the starting point of a move knob with respect to its draw item.
  MultiComboBoxLayoutStyle
  Specifies the layout of the combo box and buttons in a MultiComboBoxItem.
  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.
  MultiMessageMode
  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
  MultipleFieldStorage
  Options for how values are stored for a field that is `multiple:true`.
  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()`.
  MultiWindowEvent
  Various events triggered by any window in the current application.
  NavigationBarControls
  NavigationDirection
  Navigation direction.
  NavigationMethod
  Method of, or reason for, navigation between panes.
  NavigationMode
  Controls the navigation mode of records.
  NotifyTransition
  NullAccessType
  The possible access types for records with a null `ownerIdField` (only applicable if `ownerIdField` is specified)
  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
  OutputWhen
  The type of condition field must match in order to be fetched from underlying source of data and delivered the client.
  Overflow
  PageEvent
  Events registerable via `Page.setEvent()`
  PageOrientation
  Is this page being viewed in landscape or portrait orientation? Typically used with mobile devices.
  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.
  PartialCommitOption
  Action to take if a user attempts to save the dataset produced by a `BatchUploader` whilst it still contains errors.
  PercentBoxModel
  Determines sizing model when sizing / positioning a canvas relative to its `percentBox`.
  PickerIconName
  Standard pickers
  PickListItemIconPlacement
  For PickList items with `PickListItemIconPlacement` set such that the pickList does not render near-origin, possible location for rendering formItemIcons.
  PointShape
  Supported data point shapes for `FacetChart.pointShapes` are:
  Positioning
  PreRenderFormatValues
  Controls which formatting stages are applied to cell values during canvas `ListGrid.preRender` rendering in "data" mode.
  PreRenderImageMode
  Controls how framework-generated icons (group expand/collapse, tree openers, folder icons, value icons, boolean checkboxes) are handled in the canvas `ListGrid.preRender` preview.
  PreRenderMode
  Mode for canvas-based pre-rendering of ListGrid content.
  PreserveOpenState
  ProcessValueType
  PromptStyle
  PropertyIdentifier
  A means of identifying the properties in an exported dataset - either the property name or its title.
  ProportionalResizeMode
  ReadOnlyDisplayAppearance
  Dictates the appearance of form items when `FormItem.canEdit` is set to `false`.
  RecategorizeMode
  Determines whether records are recategorized on databound componenty drop rather than just being added to the drop target.
  RecordComponentPoolingMode
  The method of component-pooling to employ for `recordComponents`.
  RecordDropAppearance
  Controls how ListGrid record drop events report their `dropPosition`, and where the drop indicator will be displayed if appropriate.
  RecordDropPosition
  Position of a `ListGrid.recordDrop()` operation with respect to the target record.
  RecordLayout
  Controls the style of TableView record display
  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`.
  RegressionLineType
  Supported regression algorithms for fitting the data points of a scatter plot.
  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.
  ReorderPosition
  Controls where a drag-item should be dropped in relation to the target row
  ResizeDirection
  ResizeKnobPoint
  Specifies the position of a resize knob with respect to its draw item.
  RESTAuthenticationType
  Enumeration of the supported authentication types for the `RestConnector` implementation.
  RESTRequestFormat
  Indicates the request format to be used for a REST operation.
  RESTResponseFormat
  Indicates the response format to be used for a REST operation.
  RowCountStatus
  Enumerated status indicating whether a ResultSet has an accurate `ResultSet.getRowCount()` row count for the data set.
  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?
  RowRangeDisplayStyle
  Governs how `ListGrid.getRowRangeDisplayValue()` formats the row range and row count for display
  RowSpanEditMode
  When `ListGrid.allowRowSpanning` is enabled, certain cells may span multiple rows.
  RowSpanSelectionMode
  Behavior of selection when row spanning is active.
  RPCTransport
  Smart GWT supports multiple RPC transports for maximum compatibility and feature richness.
  SavedSearchStoredState
  What should be stored by a saved search?
  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
  SearchEditorMode
  Affects the appearance and behavior of the builtin `SavedSearchEditor`.
  Selected
  SelectedAppearance
  Appearance when a component is in `edit mode` and is selected.
  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`.
  SelectionNotificationType
  Enum to indicate selection change notification types.
  SelectionStyle
  Different styles of selection that a list, etc.
  SelectionType
  Controls how an object changes state when clicked
  SelectItemsMode
  Controls whether and when individual items are selected when clicking on a form in editMode.
  SendMethod
  SequenceMode
  The possible types of sequence handling Smart GWT Server can apply.
  SettledPromiseStatus
  The eventual state of a settled Promise.
  ShowDataValuesMode
  Strategy for determining whether and when to show `formatted text labels` for data-values.
  ShowMessageType
  Type of message to display in `ShowMessageTask`.
  Side
  Side of a component.
  SkipJSONValidation
  SnapGridStyle
  SortArrow
  Do we display an arrow for the sorted field ?
  SortDirection
  SQLPagingStrategy
  The technique Smart GWT Server's SQL DataSource should use to select a "page" of data from a table.
  SQLType
  The types of custom query that can be handled by Smart GWT's built-in "sql" and "hibernate" DataSources.
  StackDirection
  StackPersistence
  StandardControlGroup
  State
  Constants for the standard states for a StatefulCanvas.
  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.
  TabBarControls
  TableMode
  Controls the display mode of TableView record display
  TabTitleEditEvent
  An event that triggers title editing in a TabSet.
  TextAreaWrap
  TextMatchStyle
  For "fetch" operations, how simple search criteria should be interpreted for text fields (and to some extent numeric fields, see the notes below).
  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)
  TileLayoutPolicy
  Policy for laying out tiles.
  TimeDisplayFormat
  String designating a standard time format for displaying the times associated with dates strings.
  TimeFormatter
  Deprecated.
  Use `DateDisplayFormatter` instead
  TimeUnit
  An enum of time-units available for use with the `RelativeDateItem`, `TimeItem` and `Calendar` widgets.
  TitleAlign
  Supported positioning of the chart Title.
  TitleAutoFitRotationMode
  Strategy for determining how to place maximum-sized labels for `DrawItem.titleAutoFit`.
  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.
  TopOperatorAppearance
  Interface to use for showing and editing the `top-level operator` of a FilterBuilder.
  TourActionType
  TourInputValidationMode
  Policy for how `inputValidation` is performed for `actionType`:"change".
  TourMode
  TreeFilterMode
  Mode for applying criteria to a tree.
  TreeModelType
  UnionFieldsStrategy
  The strategy used when auto-deriving the fields that make up a UnionDataSource, if no `unionFields` setting is provided.
  ValidationMode
  Mode of validation used for running validation on partially entered data.
  ValidatorType
  Used to name a validator or reference a standard, built-in `Validator` - see list below.
  ValueClass
  ValueEnum
  ValueItemType
  Enum used within the `FilterBuilder` class to indicate the role of a particular value-field form item within a filter clause.
  VerticalAlignment
  ViewName
  The names of the Calendar views.
  Visibility
  VisibilityMode
  Settings for whether multiple sections can be in the expanded state simultaneously.
  WaitForType
  WriteToGeneratedFields
  Indicates the category of "generated fields" the Smart GWT Server should write values to, if defined on a `DSRequest` - see `writeToGeneratedFields`.
  ZoomStartPosition