XEO Web Components Reference

This section provides information about XEO Web Components (XWC the visual layer of the XEO Framework. You'll find information about the components provided by XEO, you'll also find tutorials and reference material about how to create your own component or how to create a plugin to an existing component.You can find the following content in this section:

XEO Web Components List (The list of all components provided by XEO and their documentation)
Java samples (Snippets of Java Code that perform a common action)
Custom Web Component Creation (Create a new component from scratch)
Web Component Plugins (Change the behavior of an existing component)
Internationalization (Learn how to localize your viewers/components)
Viewer Events (Learn to interact with a viewer in its life-cycle)
Value Change Listeners (Respond to changes in a value of a component)
Libraries (Reference of Java Libraries/Frameworks used by XWC)

XEO Web Components List

The XEO Framework includes a set of pre-defined components to accelerate the programer's job. There are two types of components, the ones that can be used freely and the ones that are binded to XEO objects.

The components binded to XEO Models are designated XEO Components and the not-binded are XVW Components (there are XVW components which can be binded to XEO Models, but it's not a requirement).

XEO Components:

As explained before, XEO Components are typically binded to a XEO Object and there are several categories of components

XEO Components - Forms

FormEdit - Form to edit a XEO Object
FormList - Form to list a set of XEO Objects
FormLookupList - Form to allow the selection of a XEO Object from a list of XEO Objects

XEO Components - List of Objects

List - A list of XEO objects
Bridge - The list of objects in a bridge of a given XEO Object
LookupList - A list of objects to make a selection from (a Lookup)

XEO Components - Toolbars

EditToolBar - A toolbar for use with FormEdit components
ListToolBar - A toolbar for use with FormList components
LookupListToolBar - A toolbar for use with FormLookupList components
BridgeToolBar - a toolbar for use with Bridge components
ModelMethod - A menu that invokes a method defined in a XEOModel
MenuCounter - A menu that has a counter (unread messages in outlook style)

XEO Components - Other

SplitedLookup - A lookup that allows searching

XVW Components:

AjaxText - A component to constantly update text via ajax
Action Button - A simple button to invoke an action
Button HTML - A simple button to invoke an action
Column
(xeo)ColumnAttribute - extends (xvw)ColumnAttribute
(xvw)ColumnAttribute - To customize columns in list components
Columns
Charts
- PieChart - To create Pie Charts
- BarChart - To create horizontal/vertical bar charts
- LineChart - To create line charts
Dialog Progress - To display feedback while a long-running operation is in course
Error Messages - To display error messages in a viewer
Form - Form with dependences control
GlobalSearch - A toolbar component, typically to be placed in a main viewer
GridExplorer - A listing of elements with preview capabilities and saving views (also sharing views)
GridPanel - A table with a listing of elements (columns can be ordered, grouped, etc..)
- GridNavBar - A navigational bar for the GridPanel
HTML File Browse - A file selection component
IncludeCss
IncludeScript
MainLayout
Menu - Create Menus in Toolbar and Tree components
Message Box - Message boxes of several types
Output HTML - To output HTML code directly to the browser
Panel - A panel to create sections in the viewer
Progress Bar - A progress bar to show the progress of a given operation
RegionLayout
- BottomRegion
- LeftRegion
- RightRegion
- TabPanel
RequestAction
- RequestActionValue
Rows - Creates a table to place elements
- Row - Creates a row inside the table
  - Cell - Creates a column inside a row
Section - The equivalent of an HTML fieldset
Tabs - Container for tab components
- Tab - To create a tab in the application where content can be rendered
Title - Component to render a title to the viewer
Tool Bar - Generic toolbar to place buttons that execute actions
Tree Panel - A tree structure with menus
- TreePanelToolBar - A toolBar of treePanel
Window

XVW Components - Form Attributes (Input):

In form components, input components can be used to the gather input from a user

AttributeBase- Base component from which all component inherit their properties

Attribute - Renders a label and an input field of chosen type (can be binded to a XEO Object attribute)
AttributeText - For small text values
AttributeNumber - For numeric values
AttributeBoolean - For boolean values (yes/no, true/false) values
AttributeDate - For Date values (does not include time)
AttributeDateTime - For DateTime values (includes time information)
AttributeTime - For time values (does not include date information)
AttributeFile - For Binary Files
AttributeImage - Renders the content of a binary file as an image
AttributeWordMacro - For Binary files with special compatibility to work with MS Word Templates
AttributeHtmlEditor - To Edit HTML
AttributeLabel
AttributeLov - For a list of values
AttributeNumberLookup - To select a XEOObject (keeping the value of its BOUI)
AttributePassword - For password values
AttributeSearchLookup
AttributeTextArea - For long textual values
AttributeTime

XVW Components - Form Attributes (Output):

AttributeOutput - To output any content

Java API Samples

A list of Java code snippets regarding common operations with the Java API of Web Components ( read more)

XEO Web Components - Custom Component Creation

How to create a custom component a use it in a viewer.( read more)

Internationalization ( I18N)

It's possible to have messages for the various components/viewers localized in multiple languages, the procedure on how to achieve that is described in the I18N page.