com.ebasetech.xi.api
Interface Component

All Superinterfaces:

Element, java.io.Serializable

public interface Component
extends Element

The Component interface represents a component deployed into a form.

Individual components can be accessed via the Components interface.

Since:

V4.4

Method Summary

Controls	getControls() Returns the Controls object that gives access to all controls available to the component.
Fields	getFields() Returns the Fields object that gives access to all fields available to the component.
Pages	getPages() Returns the Pages object that gives access to all pages available to the component.
java.lang.String	getPrefix() Returns the component prefix.
Resources	getResources() Returns the Resources object that gives access to all resources available to the component.
Tables	getTables() Returns the Tables object that gives access to all tables available to the component.

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Method Detail

getResources

Resources getResources()

Returns the Resources object that gives access to all resources available to the component. An individual resource can then be accessed using its resource name as shown in the examples below.

Javascript example:

 components.PREFIX1.resources.EMAIL1.sendmail();
 components.PREFIX1.getResources().WEB_SERVICE1.call();
 

Returns:

Resources

Since:

V4.4

getFields

Fields getFields()

Returns the Fields object that gives access to all fields available to the component. An individual field can then be accessed using its field name as shown in the examples below.

Javascript example:

 var v1 = components.PREFIX1.fields.FIELD1.value;
 var v2 = components.PREFIX1.getFields().FIELD_2.value;
 

Returns:

Fields

Since:

V4.4

getTables

Tables getTables()

Returns the Tables object that gives access to all tables available to the component. An individual table can then be accessed using its table name as shown in the examples below.

Javascript example:

 var t1 = components.PREFIX1.tables.TABLE1;
 var t2 = components.PREFIX1.getTables().TABLE2;
 

Returns:

Tables

Since:

V4.4

getPages

Pages getPages()

Returns the Pages object that gives access to all pages available to the component. An individual page can then be accessed using its page name as shown in the examples below.

Javascript example:

 var p1 = components.PREFIX1.pages.PAGE1;
 var p2 = components.PREFIX1.getPages().PAGE2").value;
 

Returns:

Pages

Since:

V4.4

getControls

Controls getControls()

Returns the Controls object that gives access to all controls available to the component. An individual control can then be accessed using its control name as shown in the examples below.

Javascript example:

 components.PREFIX1.controls.TEXTCONTROL1.hide();
 components.PREFIX1.getControls().BUTTONCONTROL2.backgroundColor = "Red";
 

Returns:

Controls

Since:

V4.4

getPrefix

java.lang.String getPrefix()

Returns the component prefix.

When nested components are used, a Component object exists for each unique prefix. For example, if component COMP1 is inserted into component COMP2 which in turn is inserted into a form, two Component objects will exist with prefixes something like:

• ACOMP1__BCOMP2
• ACOMP1

The Component object with prefix ACOMP1__BCOMP2 contains only the elements in component COMP2, whereas the Component object with prefix ACOMP1 contains all the elements in component COMP1 including those from COMP2.

Returns:

component prefix

Since:

V4.4