Package com.smartgwt.client.docs
package com.smartgwt.client.docs
This package contains conceptual overviews covering cross-cutting concerns that apply to
multiple SmartGWT classes and packages. These appear in JavaDoc as Java Interfaces in order to
allow interlinking with normal JavaDoc reference. Do not import this package in your Java code.
-
InterfacesClassDescriptionAccessibility / Section 508 complianceAdmin ConsoleAdvanced FilteringThe following APIs are all related to Ai.The following APIs are all related to AllowedOperations.Parent/child relationshipsThe following APIs are all related to Animation.Properties defining an object's appearanceApplication Declaration FilesThe following APIs are all related to Auth.An autoChild is an automatically generated subcomponent that a component creates to handle part of its presentation or functionality.A string with the format "autoChild:autoChildName" passed as a
Tab.paneorsection iteminstead of an actualCanvasor ID.Using AutoChildrenThe following APIs are all related to AutoFitData.The following APIs are all related to AutoFitFields.Automated TestingThe following APIs are all related to AutoTest.An AutoTestLocator is a string generated by theAutoTestclass to reliably identify an interactive element in a Smart GWT application.Background DownloadMockup ImporterThe following APIs are all related to BarChart.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.The following APIs are all related to Basics.Binary FieldsSupported BrowsersNative Browser Zoom SupportSimpleTypessupport a mechanism for arranging values into groups.The following APIs are all related to Button.Button IconThe following APIs are all related to Buttons.The following APIs are all related to CacheSync.Automatic Cache SynchronizationCachingThe following APIs are all related to CalculatedDataSourceFields.The following APIs are all related to CalendarEvent.ACallbackis an arbitrary action to be fired - usually passed into a method to be fired asynchronously as a notificaction of some event.
Thecallbackcan 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 asthis.
- methodName: if specified we'll check for a method on the target object with this name.
Callbacksare fired via the Class.fireCallback() method, which allows named parameters to be passed into the callback at runtime.As withstateful canvases, grid cells support being styled to reflect the current state of the cell by generating a css styleName from the specifiedbaseStyle, plus stateful suffixes.The following APIs are all related to CellStyling.The following APIs are all related to ChangeHandling.The following APIs are all related to ChartFeatures.The following APIs are all related to ChartProperties.The following APIs are all related to ChartTitle.The following APIs are all related to ChartType.The following APIs are all related to CheckboxField.The following APIs are all related to ClickMask.The following APIs are all related to ClientData.Client-side Data IntegrationClient Only DataSourcesClient-Server IntegrationThe following APIs are all related to Clipping.ComboBoxItem PickList FilteringComboBoxItem criteriaThe following APIs are all related to Communication.Component BindingComponent SchemaComponent XMLWhen 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.CompressionHandling concurrent edits in Smart GWT DataSourcesThe following APIs are all related to Constant.Component Containment and HierarchyThe following APIs are all related to ContentLoading.The following APIs are all related to Contents.The following APIs are all related to Corner.Criteria for selecting only a matching set of records from a DataSource.Criteria EditingCSS color specification applied to a specific HTML element on this page.CSS class name to apply to some HTML element on this page.A String of CSS that can be added directly to astyleattribute.Visual hints for the user that something can be done to this objectThe following APIs are all related to Cursor.Custom Querying OverviewCustomizing Sass-based SkinsIncluding custom elements in the tab orderThe following APIs are all related to Data.DataBindingDataBound Component MethodsThe following APIs are all related to DataContext.String specifying a nested data field structure.The following APIs are all related to DataPoints.Creating DataSourcesDataSource and Component XML LocalizationDataSource OperationsRelationsDataSources TabThe following APIs are all related to DataType.The following APIs are all related to Date.Date and Time Format and Storage3 character string containing the"M","D"and"Y"characters to indicate the format of strings being parsed into Date instances viaDateUtil.parseInput().The following APIs are all related to DateItemAppearance.Database ConfigurationDebuggingUsing the Debug ModulesDeclarative SecurityDeployment Management ConsoleAn object containing the stored grouping information for a detailViewer.The Developer Console RPC TabDashboards & Tools Framework OverviewThe following APIs are all related to Display.Direct Method InvocationDOM Integration & Third-party ComponentsThe following APIs are all related to Drag.Drag and DropThe following APIs are all related to Dragging.The following APIs are all related to DragHandleField.The following APIs are all related to Dragndrop.The following APIs are all related to DragResize.The following APIs are all related to DragTracker.The following APIs are all related to DrawContext.Rendering an object on the page.DataSource Facade patternDSRequest data auto-converted to bean typesVarious subsystems have a need to compare DataSource requests and understand if they are equivalent or affect the same data (examples includeautomatic cache synchronizationandoffline caching and synchronization).The following APIs are all related to DsResponse.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.If a property indicates it has support for "dynamic criteria" it means that values in the criteria may be dynamically derived from the currentCanvas.ruleScopeusingCriterion.valuePath.The following APIs are all related to DynamicMenuItem.Object used to specify custom edge sizes or offsets.Grid EditingManipulating native form elementsThe following APIs are all related to EmptyMessage.Enabling and DisablingError Handling OverviewThe following APIs are all related to ErrorIcon.Validation errors and how they are shownThe following APIs are all related to EventRegistry.Copy and Paste with ExcelThe following APIs are all related to ExpansionField.Experimental FeaturesThe following APIs are all related to ExportBackgroundColor.Exports & Cell Background ColorExports & FormattingServer Features and Custom PersistenceThe following APIs are all related to Fetching.The following APIs are all related to FieldGeneration.Field-Level SecurityName for a field.The following APIs are all related to Fields.An object containing the stored presentation information for the fields of some dataBoundComponent.File AssemblyReferring to and loading other files.FileSource OperationsThe following APIs are all related to FilterEditor.The following APIs are all related to FlatFields.FocusA String to be used as a format specifier for a date, datetime, time or numeric field, via theformatandexportFormatproperties.The following APIs are all related to FormIcons.This string is the base CSS class name applied to a FormItem (or some part of a form item).Name of a Smart GWT Class that subclassesFormItem.FormItem StylingForm LayoutForm TitlesFields with values calculated from other fields in the grid.DataSourceField formula functionsThe following APIs are all related to FormValues.Values ManagerFrozen FieldsGoogle Application Engine (GAE)Determining the size of a drawn canvasAnIdentifierthat's unique in the global scope.The following APIs are all related to Gradations.Grid Filtering OverviewProperties and methods related to the ListGrid header.ListGrids support automatic validation of edited cells / records.The following APIs are all related to Grip.The following APIs are all related to Grouping.Float vs DoubleBeans and the DSRequest / DSResponseThe following APIs are all related to HeaderMenuButton.The following APIs are all related to HeaderSpan.Integration with HibernateHilitingThe following APIs are all related to HistogramChart.The following APIs are all related to HoverComponents.The following APIs are all related to Hovers.A synonym forHTMLString.The following APIs are all related to HtmlElement.A String of HTML, such as "text".Internationalization and LocalizationThe following APIs are all related to Icon.A string which is a valid Java and JavaScript identifier, as specified by ECMA-262 Section 7.6.The following APIs are all related to Identity.Internet Explorer "filter" effectsUtilities to render imagesColumns that show images either as their only appearance or in addition to text.The following APIs are all related to ImageEdges.The following APIs are all related to ImageEdgeStyles.Referring to and loading images.The following APIs are all related to InlineFormItems.Integrating AI TechnologySmart GWT Server SummaryThe following APIs are all related to Items.Java Module DependenciesConverting JavaScript objects to JavaConverting GWT Java objects to JavaScriptJPA & Hibernate RelationsIntegration with JPAJUnit + Selenium WebDriverKeyboard EventsStrings to identify the various keys on the keyboard.The following APIs are all related to KeyRegistry.The following APIs are all related to Labels.The following APIs are all related to LabelsAndTitles.The following APIs are all related to Layout.The following APIs are all related to LayoutMargin.Properties that can be set on members of a layout to control how the layout is doneThe following APIs are all related to LayoutPolicy.The following APIs are all related to Legend.The following APIs are all related to Lifecycle.The following APIs are all related to Line.An object containing the stored presentation information for the fields of a listGrid.An object containing the stored grouping information for a listGrid.An object containing the stored selection information for a listGrid.An object containing the stored sort information for a listGrid.An object containing the stored criteria as applied by the user.An object containing the "view state" information for a listGrid.<isomorphic:loadAssembly>The following APIs are all related to LoadingIndicator.Loading Optional Modules<isomorphic:loadProject>The following APIs are all related to LoadState.Localized Number FormattingThe following APIs are all related to Location.Logging migrationWhen events fill a day or span multiple days, it becomes impractical to view and interact with them in normal Calendar views.The following APIs are all related to Mail.Manual JPA & Hibernate IntegrationMaven SupportThe following APIs are all related to Media.The following APIs are all related to Members.Memory LeaksThe following APIs are all related to Menu.The following APIs are all related to MenuBasic.The following APIs are all related to MenuIcons.The following APIs are all related to MenuItems.The following APIs are all related to MenuKeys.Real-Time MessagingThe following APIs are all related to Minimize.Mobile Application DevelopmentThe following APIs are all related to Modal.The following APIs are all related to MonthViewEvents.The following APIs are all related to MonthViewFormatting.The following APIs are all related to MouseEvents.A MultiAutoChild is ancom.smartgwt.client.types.AutoChildwhere the creating component usually creates more than one, hence, unlike a normal AutoChild, the AutoChild is not accessible ascreator.[autoChildName].The following APIs are all related to MultiLinkTree.The following APIs are all related to MultipleField.Transparent Multi-TenancyNetwork PerformanceDon't Misuse Frames.NET, PHP, Serverless IntegrationAn identifier passed toNotifyAPIs to group related messages together so that they all use the same behavior and display settings.NPMJS SupportServer-side OData DataSourceThe following APIs are all related to Offline.The following APIs are all related to OfflineGroup.OpenAPI Specification (OAS) SupportOperations OverviewThe following APIs are all related to Orientation.The following APIs are all related to Paging.The following APIs are all related to PanelPlacement.Thesearch operatorsuse patterns like "foo*txt" to match text values.Canvas Percentage sizingThe following APIs are all related to Performance.Integration with PhoneGapThe following APIs are all related to PickerIcon.Properties and methods related to the pickList, which is the drop-down list of options that appears under a SelectItem or ComboBoxItem.The following APIs are all related to PieChart.Platform DependenciesWriting AutoTests for multiple environmentsHorizontal and vertical location on the pagePrintingProgressive LoadingThe following APIs are all related to Prompt.Objects / methods used for displaying prompts and warnings to the user via (possibly modal) isc Dialog objects.The following APIs are all related to PseudoFieldGeneration.Quartz DataSourcesThe following APIs are all related to RadarChart.The following APIs are all related to ReadOnly.The following APIs are all related to RecordComponents.The following APIs are all related to Rects.Registering Classes for ReflectionReify OverviewReify OnSite: Adding Custom Workflow TasksAdding Custom Components to ReifyAdding Custom DataSources to ReifyReify for DevelopersImporting from ReifyReify MessagingReify OnSiteA RelativeDateShortcut is a special string that represents a shortcut to a date phrase that can be automatically mapped to aRelativeDateStringfor use in widgets that leverage relative-dates, such as theRelativeDateItem.A string of known format used to specify a datetime offset.Generating Reliable AutoTestLocatorsReloginRemote DebuggingThe following APIs are all related to Resizing.The following APIs are all related to RibbonGroup.The following APIs are all related to RowCountDisplay.The following APIs are all related to RowEffects.The following APIs are all related to RowNumberField.Grid row-range and row-count displayThe properties in this group all deal with setting and styling a modal prompt during an RPC call to the server.The following APIs are all related to RTL.Dynamic RulesSafe SkinningName of a SmartGWT class, including framework classes such as "ListGrid", or custom subclasses you have created.For properties that refer to images by URL, such asImg.srcandButton.icon, Smart GWT provides various capabilities to allow for simpler and more uniform settings, and to allow applications to be restructured more easily.The following APIs are all related to Scroll.Scrolling and clipping of objects when part of the object is obscuredUsing SpritesDeploying the Smart GWT SDKThe following APIs are all related to Search.The following APIs are all related to SearchCriteria.Selectionserver.propertiesfileServer DataSource IntegrationNotes on Server-side DataSource ImplementationsServer Framework InitializationServer loggingServer-side REST ConnectorServer ScriptingServer SummariesThe Core and Optional Smart GWT servletsManual Setup & Deployment of Smart GWT Pro/EESmart GWT Pro/EE Project SetupSGWTPropertiesThe following APIs are all related to Shadow.Sharing NodesSimple Names modeWidth and height of an objectSkin EditorSkinning / ThemingSkins are a collection of styles, images and other settings used to manage the overall appearance of an application.Smart GWT ArchitectureIntegrating Smart GWT with CypressCanvas.childrenSnapToGridand related properties, which causes snap-to-grid behavior during drag and drop.Canvas.snapToand related properties for positioning widgets relative to other widgets edges and corners.The following APIs are all related to Sorting.Integration with SpringSQL Connection PoolingSQL DataSourcesThe following APIs are all related to SqlPaging.SQL Database Settings inserver.propertiesSQL DataSource vs JPA, EJB, MyBatis and other technologiesStandalone DataSource UsageChange of state and it's consequences for presentation.Stateful ImagesThe following APIs are all related to Statistics.Status codes returned by the server as rpcResponse.status.
See the error handling doc section inRPCManagerfor more information on these codesStockIcons OverviewStrict ModeA String containing a valid JavaScript expression that's automatically converted to a function with a return value matching the value of the last statement.String Methods OverviewDirect submission of forms to a target URLSun's java-engine implementation - Notice and DisclaimerTroubleshooting GWT Development Mode (formerly Super Dev Mode)SVG Symbols OverviewThe following APIs are all related to TabBar.The following APIs are all related to TabBarControls.The following APIs are all related to TabBarScrolling.The following APIs are all related to TableLayout.AnIdentifierthat must be locally unique within the containingTabSet.Tab Order OverviewTask Input ExpressionsTask Input / OutputTest DataTestRunnerText DirectionThe following APIs are all related to Thumb.The following APIs are all related to Ticks.The following APIs are all related to TileLayout.Integration with TitaniumThe following APIs are all related to Title.The following APIs are all related to Titles.The following APIs are all related to Toolbar.Tools DeploymentThe following APIs are all related to Track.Transaction ChainingTree DataBindingThe following APIs are all related to TreeField.The following APIs are all related to TreeFilter.TreeGrid drag and dropAn object containing the open state for a treeGrid.An object containing the "view state" information for a treeGrid.The following APIs are all related to TreeIcons.Troubleshooting thread deadlocks on the serverUnion DataSourcesHandling Unsaved RecordsUploading FilesA Uniform Resource Identifier string, as defined by https://tools.ietf.org/html/rfc3986.A Uniform Resource Locator string, as defined by https://www.w3.org/Addressing/URL/url-spec.html.Using Selenium Scripts (Selenese)ValidationExplicitly defined validators on the dataSource field are run in the order in which they are defined on the client and on the server.The following APIs are all related to ValueIcons.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.An expression in the Velocity Template Language (VTL).Velocity context variablesThe following APIs are all related to ViewFile.The following APIs are all related to ViewLoading.The following APIs are all related to ViewState.Whether an object can be seenVisual BuilderThe following APIs are all related to WebService.Window HeaderThe following APIs are all related to WindowMembers.The following APIs are all related to Workday.Custom Server DataSourcesWSDL BindingServer 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 JavaScriptAll rules described in this topic are applied any time a property is of typeAdvancedCriteria(in both Component XML and JavaScript component creation) and any API declares anAdvancedCriteriaparam.The following APIs are all related to XmlSchema.The following APIs are all related to XmlSerialize.<isomorphic:XML>The following APIs are all related to XmlTransform.A standard XPath expression as a string.XSS and CSRF SecurityObject's "stacking order" above or below other objectsThe following APIs are all related to Zoom.