Component

Component

This tag is used to define a component on the page. A component consists of multiple elements.

Attributes

NameDescriptionValue
id

Unique Identifier

any
nameA name that describes the componentany
tipexpressionA question mark that is positioned on the top left corner of the component and when the mouse moves over it an information box appearsany
newrowMoves the component to the next row. The default value is false.true, false
isgroupBoolean that specifies if the component will be displayed as a group of multiple elements.

true

false
visibilityconditionsThe conditions that should be met in order to display the component.'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
readonlyconditionsThe conditions that should be met in order for the component to become read-only.'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
visiblemodesThe modes that the component is visible. The component is visible in every mode by default.new,edit,read
showonlyinmodalIf it is set to true then the component will be visible only when the page opens in modal. The default value is false.

true, false

hideinmodalIf it is set to true then the component will be hidden only when the page opens in modal. The default value is false.true, false
columnsThe number of columns the component is divided into. The default value is 1.numeric
isgroupIf it is set to true then the component is displayed as a group of elements. the name of the component appears as the title of the group.

true, false

allowcollapseIf the component is defined as group and this value is set to true then the user can collapse/expand the component by clicking the title of the group.

true, false

defaultcollapsedIf the component is defined as group and this value is set to true then the group of elements is by default collapsed.

true, false

elementsThe elements of the component.List of elements.
quickcreateIf it is set to true then the component is displayed in "quick create" mode.

true, false

Example

 Component

 

Definition
			<component>
				<id>cmpViewCharacteristics</id>
				<name>View Characteristics</name>
				<visibilityconditions>'[[getValue,java.lang.String,type/id]]'!=''</visibilityconditions>
				<isgroup>true</isgroup>
				<allowcollapse>true</allowcollapse>
				<columns>2</columns>
				<elements>
					<selectbox>
						<id>slbClassification</id>
						<label>Classification</label>
						<lookuptype>ejb</lookuptype>
						<datapath>type/classification</datapath>
						<datatype>enum</datatype>
						<classname>com.crm.dataobject.products.ProductTypeClassification</classname>
						<reload>true</reload>
						<readonly>true</readonly>
						<onload>
							<type>ejb</type>
							<classname>ejb/CRMUIProductType</classname>
							<functionname>getClassificationOptions</functionname>
						</onload>
					</selectbox>
					<selectbox>
						<id>slbCompositionMethod</id>
						<label>Composition Method</label>
						<lookuptype>ejb</lookuptype>
						<datapath>type/compositionMethod</datapath>
						<datatype>enum</datatype>
						<classname>com.crm.dataobject.products.CompositionMethod</classname>
						<reload>true</reload>
						<readonly>true</readonly>
						<onload>
							<type>ejb</type>
							<classname>ejb/CRMUIProductType</classname>
							<functionname>getCompositionMethodOptions</functionname>
							<parameters>
								<parameter>
									<value>[[getValue,java.lang.String,type]]</value>
									<datatype>java.lang.Object</datatype>
								</parameter>
							</parameters>
						</onload>
					</selectbox>
					<selectbox>
						<id>slbServiceType</id>
						<label>Service Type</label>
						<lookuptype>ejb</lookuptype>
						<datapath>type/serviceType</datapath>
						<datatype>enum</datatype>
						<classname>com.crm.dataobject.products.ServiceType</classname>
						<reload>true</reload>
						<readonly>true</readonly>
						<onload>
							<type>ejb</type>
							<classname>ejb/CRMUIProductType</classname>
							<functionname>getServiceTypeOptions</functionname>
							<parameters>
								<parameter>
									<value> </value>
									<datatype>java.lang.String</datatype>
								</parameter>
							</parameters>
						</onload>
					</selectbox>
					<selectbox>
						<id>slbUsedForProvisioning</id>
						<label>Used For Provisioning</label>
						<lookuptype>ejb</lookuptype>
						<datapath>type/isForProvision</datapath>
						<datatype>java.lang.Integer</datatype>
						<reload>true</reload>
						<readonly>true</readonly>
						<onload>
							<type>ejb</type>
							<classname>ejb/CRMUIProductType</classname>
							<functionname>getYesNoOptions</functionname>
						</onload>
					</selectbox>
				</elements>
			</component>