public interface ComponentSchema
Declaring a component schema for your custom component allows you to:
xsi:typeattributes as described under
Example of a Component Schema
In its most basic form, a component schema for a custom subclass of ListGrid called "com.mycompany.MyListGrid" looks like this:
<DataSource serverType="component" ID="MyListGrid" inheritsFrom="ListGrid" instanceConstructor="com.mycompany.MyListGrid"/>With this definition saved as "MyListGrid.ds.xml" in the project dataSources directory ([webroot]/shared/ds/ by default), you can now create an instance of com.mycompany.MyListGrid with just:
<MyListGrid width="500"/>Note: you may need to restart your servlet engine/J2EE container before this example will work.
The attributes set directly on the DataSource tag have special meaning for a component schema definition:
serverType="component" indicates this DataSource describes a component, as opposed to a SQL table or other data provider
IDmeans the tagName that will be used to create your custom component. This must match the first component of the filename. (ID="MyListGrid" means the filename must be MyListGrid.ds.xml, and typically also matches the name of the class).
DataSource.inheritsFrom="ListGrid" inherits the ListGrid property definitions via
Declaring custom properties
Custom properties are declared via
as for an ordinary
DataSource. As with ordinary DataSources, it is legal to
redeclare inherited fields
in order to modify properties such as
The following DataSourceField properties have special significance when a component schema
is used to process
field.typedeclares the type of the field, and hence the type of the value your custom class will be initialized with. In order to declare subcomponents, can be set to the name of another component (built-in or custom).
field.multipledeclares that the field should always be array-valued even when only a single value is provided. Also indicates that the field name should be used as a "wrapper tag" in the XML format for the component.
field.propertiesOnly. For fields that hold subcomponents, suppresses auto-construction to avoid
double drawingand to allow subcomponents to be modified by their parent component before they are created and drawn
field.inapplicableindicates that an inherited field is inapplicable in this component.
field.groupindicates what group the property should be placed in when editing in Visual Builder.
field.xmlAttribute: indicates this field should serialize as an XML attribute. Note that when constructing the component from XML, either an attribute or a subelement will continue to be accepted as means of specifying the field value, so this property is primarily set in order to make code generated by Visual Builder maximally compact or to make it conform to externally set standards.