Package com.smartgwt.client.docs

Interface Summary
AdminConsole The Admin Console allows you to configure database access for DataSources that use SmartGWT's built-in 'SQL engine'.
AdvancedFilter  
AllowedOperations  
Ancestry Parent/child relationships
Animation  
Appearance Properties defining an object's apperance
Apperance  
AutoFitData  
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.
Basics Basic definition of a DataSource field
ButtonIcon Control over optional icons shown in Buttons, Labels and other contexts
Buttons  
CacheSync  
Caching Standard web browsers can cache server responses, associating the locally-cached files with the URLs (including query parameters) that were used to fetch the files from the server.
CalendarEvent  
CellStyling  
ChangeHandling  
CheckboxField  
ClickMask  
ClientDataIntegration SmartGWT supports declarative, XPath-based binding of visual components to any server capable of returning XML or JSON responses over HTTP, without the need for the 'SmartGWT server'.
ClientOnlyDataSources For prototyping purposes, a "client-only" DataSource can be created that has no permanent storage and never contacts the server, instead using a set of test data to respond to requests in the same manner as a server-based DataSource might.
ClientServerIntegration Like client-server desktop applications, SmartGWT browser-based applications interact with remote data and services via background communication channels.
Clipping  
Communication  
ComponentBinding Properties that control how a DataBound Component binds to this DataSource
ComponentSchema A component schema is a special type of DataSource that describes a custom component.
Compression Compression helps reduce the sizes of various data fetched from the server.
Containment Canvases containing other objects as children or peers
ContentLoading  
Contents  
Corner  
Cues Visual hints for the user that something can be done to this object
Cursor  
Data  
Databinding DataBinding means the automatic, highly customizable process of 'binding' a UI component to a DataSource, so that a UI component displays, edits and saves DataSource records using appropriate formatters, editors, validation rules, and persistance logic.
DataBoundComponentMethods An Action Method initiates an orchestrated client-server flow that stores or retrieves data and updates one or more components.
DataSourceDeclaration DataSources can be specified in XML format, in which case the ISC server is used to load the DataSource in a JSP file, or DataSources can be directly created on the client via JavaScript.
DataSourceOperations A DataSource Operation is a type of 'operation' that acts on the set of stored objects represented by a DataSource, performing one of the basic actions that makes sense on a set of similar records: "fetch", "add", "update" or "remove".
DataSourceRelations Properties for declaring relations between DataSource and within DataSources, such as master-detail relationship (a SalesOrder contains 0 or more OrderItems) and tree relationships (records can be linked by a parentId field).
DataType  
Date  
Debugging Built-in Diagnostics
Display  
Drag  
Dragdrop Dragging objects and dropping them onto other objects
Dragging  
Dragndrop  
DragResize  
DragTracker  
DrawContext  
Drawing Rendering an object on the page
DsResponse  
DynamicLoading  
DynamicMenuItem  
Editing Data being displayed by a grid may be edited within the grid, by showing editing interfaces embedded inside the cells of the grid.
Elements Manipulating native form elements
EmptyMessage  
Enable Disabled components do not respond to mouse or keyboard events, and change appearance to indicate they are disabled.
ErrorIcon  
Errors Validation errors and how they are shown
EventRegistry  
Fetching  
Fields  
FileAssembly File assembly concatenates multiple files into a single response, reducing the number of HTTP fetches required to load a page.
Files Refering to and loading other files.
FilterEditor  
FlatFields  
Focus Focus is the ability to become the target of keyboard input events.
FormIcons  
FormLayout FormItem Placement in Columns and Rows
FormTitles Properties that affect form item title placement and styling.
FormulaFields Fields with values calculated from other fields in the grid.
FormValues  
FormValuesManager  
FrozenFields Frozen fields are fields that do not scroll horizontally with other fields, remaining on the screen while other fields may be scrolled off.
GridHeader Properties and methods related to the ListGrid header.
GridValidation ListGrids support automatic validation of edited cells / records.
Grip  
Grouping  
HeaderMenuButton  
HeaderSpan  
HibernateIntegration SmartGWT can integrate with Hibernate in two main ways: With pre-existing Hibernate configuration and Java beans, SmartGWT server-side DSRequests can be transformed into Hibernate Criteria objects, and results returned via a SmartGWT DSResponse.
Hovers  
HtmlElement  
Identity  
Image Utilities to render images
ImageColumns Columns that show images either as their only appearance or in addition to text.
ImageEdges  
ImageEdgeStyles  
Images Refering to and loading images.
InlineFormItems  
IscInstall This overview serves as a how-to for installing SmartGWT into your web application. Evaluators are urged to use the SmartGWT SDK with the embedded tomcat servlet engine during evaluation rather than pursue installation into an existing web application up front, however, reading this document and the related 'server integration' materials is recommended to get an overview.
IscServer The SmartGWT Server is a set of Java libraries, servlets and tools that provide the key server-side components needed to build a complete application in the modern web architecture.
Items Manipulating the items that belong to a form.

An item manages an atomic value (eg a String, Number, Date, etc) that appears as one of the properties in the overall form's values.
KeyboardEvents  
KeyRegistry  
Labels  
LayoutMargin  
LayoutMember Properties that can be set on members of a layout to control how the layout is done
LayoutPolicy  
Line  
LoadingDataMessage  
LoadState  
Location  
Members  
MenuBasic  
MenuIcons  
MenuItems  
MenuKeys  
Minimize  
Modal  
MonthViewEvents  
MonthViewFormatting  
MouseEvents  
NetworkPerformance This section describes various methods for optimizing delivery of your SmartGWT-based application to the browser.
NoFrames Loading the SmartGWT framework into multiple frames or iframes within the same browser is not a supported configuration, or more accurately, not a supportable configuration, for the following reasons: each additional frame multiplies the memory footprint and reduces speed having multiple frames prevents drag and drop between components in different frames modality handling (eg modal dialogs) doesn't automatically take into account multiple frames (consider tabbing order, nested modality and other issues, you'll see it's not realistic to provide automatic cross-frame modality handling) inter-frame communication triggers several browser bugs: memory leaks, performance issues, intermittent crashes in some browsers, inconsistencies in basic JavaScript operators such as "typeof", and problems with form focus handling in IE, among many other bugs None of these problems are specific to SmartGWT.
NonJavaBackend SmartGWT is fully functional without installation of the Java server included in the SDK, and can be integrated with any server technology.
Operations SmartGWT Operations are dynamic, transparent communications made from the client-side SmartGWT system running in the browser, to the server-side SmartGWT system running in a servlet engine, or to other non-SmartGWT servers available via HTTP.
Orientation  
Paging  
Performance  
PickerIcon  
PlatformDependencies Client-side processing of web services, XML parsing, and some UI loading mechanisms rely on a native in-browser XML parser and/or the XMLHttpRequest object - one or both of which will not be available if the end user disables ActiveX support in Internet Explorer.
Positioning Horizontal and vertical location on the page
Printing  
Prompt  
Prompting Objects / methods used for displaying prompts and warnings to the user via (possibly modal) isc Dialog objects.
Rects  
Relogin For applications that require authentication and use session timeout, a background RPC may occur with an expired session.
Resizing  
RowEffects  
RpcPrompt The properties in this group all deal with setting and styling a modal prompt during an RPC call to the server.
SafeSkinning The skinning mechanism is extremely powerful and gives you the ability to change internal functionality of components.
Scroll  
Scrolling Scrolling and clipping of objects when part of the object is obscured
Selection APIs for marking Records as selected and retrieving the selected record or records.
ServerDataIntegration Server Data Integration means: You 'install' the 'SmartGWT Java Server' into any J2SE/J2EE environment You 'create DataSources' in either XML or JavaScript, possibly on-the-fly from 'existing metadata'.
Shadow  
SharingNodes For local Trees, that is, Trees that don't use load on demand, SmartGWT supports setting up the Tree structure by setting properties such as "childrenProperty", directly on data nodes.
Sizing Width and height of an object
Skinning Skinning (aka "theming" or "branding") is the process of modifying SmartGWT's default look and feel to match the desired look and feel for your application.
Skins Properties used to manage to the the overall appearance of the application.
SmartArchitecture SmartGWT can add interactivity and performance benefits to any web application with a variety of integration approaches.
Sorting  
SpringIntegration Overview
SqlDataSource For prototyping purposes, the ISC server supports basic SQL connectivity for DataSources defined in XML.
State Change of state and it's consequences for presentation.
StatusCodes Status codes returned by the server as rpcResponse.status.
See the error handling doc section in RPCManager for more information on these codes
Submitting Direct submission of forms to a target URL
TabBar  
TabBarControls  
TabBarScrolling  
TableLayout Manipulating the values stored in the form.
TextDirection  
Thumb  
TileLayout  
Title  
Titles  
Toolbar  
Track  
TreeDataBinding The SmartGWT TreeGrid component is a visual representation of a tree and requires a Tree or com.smartgwt.client..ResultTree datatype passed via the data attribute to initialize the tree view.
TreeField  
TreeIcons  
Upload SmartGWT provides special client and server-side support for file upload that allows uploaded files to be treated like ordinary DataSource fields.
Validation Validation
Validtion  
ValueIcons  
ViewLoading  
ViewState  
Visibility Whether an object can be seen
VisualBuilder The SmartGWT Visual Builder tool, accessible from the SDK Explorer as Tools->Visual Builder, is intended for: business analysts and others doing functional application design, who want to create functional prototypes in a codeless, "what you see is what you get" environment developers new to SmartGWT who want to get a basic familiarity with component layout, component properties and SmartGWT code structure developers building simple applications that can be completed entirely within Visual Builder
WebService  
Workday  
WsdlBinding SmartGWT supports automated integration with WSDL-described web 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
XmlSchema  
XmlSerialize  
XmlTag produces: JavaScript
XmlTransform  
ZIndex Object's "stacking order" above or below other objects