Oracle Fusion Middleware Tag Reference for Oracle ADF Mobile
11g Release 2 (11.1.2.3.0)

E26230-01

Tag Library Information

Short name: adfmf
Namespace: http://xmlns.oracle.com/adf/mf, http://xmlns.oracle.com/adf/mf/amx, http://xmlns.oracle.com/adf/mf/amx/dvt, http://xmlns.oracle.com/adf/mf/skin, http://xmlns.oracle.com/adf/mf/config

Links

Application Components

NameDescription
<adfmf:amx> Definition for the amx page.
<adfmf:application> Definition for the application. The application is the container that surfaces the included features. Attributes: id - unique id for the application name - human-readable name for the application (should be a RB token) vendor - company/team name of the implementing application version - version of the application Elements: description - a short but detailed description of the application and its purpose. error - stanza to define handlers for given error conditions featureReference - since many features can be bundled with application or Feature Archive the feature reference is used to denote which features are relevant (or can be exposed) by this application. preferences - preferences exposed by the application. navigation - navigation settings for the application. login - login page settings for the application.
<adfmf:description> A description of the application.
<adfmf:domain> The domain element is used to define an allowable domain inside ADF Mobile Framework. The domain can contain wildcards.
<adfmf:error> Registration for global exception handler page.
<adfmf:featureReference> Definition for the feature reference. id - is the associated feature id index - is the position it should initially show up in showOnSpringboard - denotes if the feature should be shown on the springboard showOnNavigationBar - denotes if the feature should be shown on the navigation bar NOTE: if showOnSpringboard and showOnTabControl are both set to false there are only two ways for the feature to show up: 1. if it is the lowest index'ed feature, hence show up on startup 2. a feature does an explicit "GOTO" feature call to it.
<adfmf:loadBundle> An additional resource to be made available to the application, ostensibly for localizing applicaiton name, preferences, etc.
<adfmf:localHTML> Definition for the local HTML page.
<adfmf:login> Login page setting.
<adfmf:navigation> Definition for the application navigation.
<adfmf:navigationBar> Navigation bar setting.
<adfmf:remoteURLWhiteList> The remoteURLWhiteList element is used to define a list of domains that can be launched inside ADF Mobile Framework. The domains can be defined as absolute domain or with wildcards, for e.g. "*.oracle.com". A domain entry with value "*" means all domains are allowed.
<adfmf:springboard> Springboard setting.
<adfmf:springboardFeatureReference> The springboard reference definition is used to denote which feature should be used as the springboard feature.
Preferences Components Preferences components may also be included in this context.

Feature Components

NameDescription
<adfmf:amx> Definition for the amx view/taskflow.
<adfmf:constraint> The constraint element is a child element of the constraints stanza. It is used to define one of the conditions that must be 'ANDed' together to determine if the constraint is satisfied.
<adfmf:constraints> The constraints element is used to determine if the outter element should be included. In order for a 'constraint' to be satisfied ALL of the constraints must evaluate to being true.
<adfmf:content> Definition for the feature content. This content can be ONE of the following forms: - localHTML - local html view - remoteURL - remote html view - nativeview - local view built with native code - amx - local ADF Mobile view or taskflow for ADF mobile views
<adfmf:description> A description of the ADF Mobile feature.
<adfmf:feature> Definition for the feature. Features are application bundles containing all the information needed to be included in the container application. Since each feature is developed independently from each other, this metadata is required to describe the feature to the framework. id - unique id for the feature name - human readable name for the feature (should be a RB token) icon - used to be displayed in the feature tab control image - used to be displayed in the springboard control credentials - the minimum credentail validation policy that must be used. listener-class - lifecycle listener class (if present) interface LifecycleListener defines three methods: 1. activated() - called when a feature is activated 2. deactivated() - called when a feature is deactivated 3. handlePushEvent() - called to process a push event NOTE: features are activated via; - human selection of the feature - programmatically transitioned to the feature - push notification event comes in vendor - company/team name of the implementing feature version - version of the feature
<adfmf:features> A set of ADF Mobile features.
<adfmf:hint> A hint.
<adfmf:include> The constraint element is a child element of the constraints stanza. It is used to define one of the conditions that must be 'ANDed' together to determine if the constraint is satisfied.
<adfmf:includes> The includes element is used to include javascripts or cascade style sheets for an amx element.
<adfmf:loadBundle> An additional resource to be made available to the features, ostensibly for localizing feature icons, images, and names.
<adfmf:localHTML> Definition for the loacl HTML view.
<adfmf:nativeview> Definition for the native view.
<adfmf:parameter> Parameter used by content types to pass standard data in.
<adfmf:remoteURL> Definition for the remote URL view.
Preferences Components Preferences components may also be included in this context.

Preferences Components

NameDescription
<adfmf:preferenceBoolean> A boolean preference setting.
<adfmf:preferenceGroup> Preference group element.
<adfmf:preferenceList> A preference setting that gives the user a set of specific items to choose from.
<adfmf:preferenceNumber> A number preference setting.
<adfmf:preferencePage> Preference page element.
<adfmf:preferences> Top level application preference element.
<adfmf:preferenceText> A text preference setting.
<adfmf:preferenceValue> A list item for a preferenceList setting.

Amx Components

NameDescription
<amx:actionListener> This component allows you to declaratively invoke an action. This component is meant to be a child component of any tag that has some kind of listener attribute like actionListener, or valueChangeListener, etc. The type attribute defines which listener of the parent this actionListener should be fired for. These methods fire before the listener on the parent component fires.
<amx:carousel> The carousel component displays a spinning series of items based on rows of a collection model.
<amx:carouselItem> The carouselItem component must be placed inside of a carousel component's "nodeStamp". It represents an item inside of a carousel component and its text attribute will be displayed when it is the current item the carousel. Although the most common child of carouselItem is image, other components may be used. For example you might use a commandLink as a child that surrounds an image. In order to minimize any negative effect on performance, you should avoid using any heavy-weight children because as you add more complexity to the structure, the effect will be multiplied because several carouselItem stamps will be displayed simultaneously.
<amx:cellFormat> A cellFormat component is used to define a cell in a rowLayout of a tableLayout.
<amx:closePopupBehavior> This tag is a declarative way to hide an amx:popup. When the closePopupBehavior tag is associated with a component, it can hide the popup on some user action.
<amx:commandButton> The commandButton component creates a button that, when pressed, will generate an action event. The button can contain text, an image, or both text and an image.
<amx:commandLink> The commandLink component creates a link that, when pressed, will generate an action event. It may also contain a child image component to create a link that displays an image rather than text.
<amx:convertDateTime> Converts string into java.util.Date and vice versa based on the pattern and style set.
<amx:convertNumber> This is an extension of the standard JSF javax.faces.convert.NumberConverter. The converter provides all the standard functionality of the default NumberConverter and is strict while converting to object.
<amx:facet> Defines an arbitrarily named facet on the parent component. The position and rendering of the facet are determined by the parent component.
<amx:goLink> This component creates a simple anchor tag that does not follow any task flow navigation and is meant for performing external links to other pages or operations such as making a call.
<amx:image> The image component displays an image.
<amx:inputDate> Renders an input field for dates.
<amx:inputNumberSlider> Creates a numeric input component. It is used to enter numbers and it has a slider to quickly increment or decrement the number.
<amx:inputText> An input text field component.
<amx:iterator> The iterator is a component that does iteration. It is similar to listView but has no chrome.
<amx:listItem> Represents a single row of a listView.
<amx:listView> An iteration component that provides the look and feel of rows with range capabilities.
<amx:loadBundle> Loads a resource bundle localized for the Locale of the current view.
<amx:outputText> Presents text data in a read-only manner.
<amx:panelFormLayout> Within the Panel Form Layout, the label area can either be displayed on the start side of the field area or on a separate line above the field area. Separate lines are used if the "labelPosition" attribute is set to "topStart", "topCenter", or "topEnd". Otherwise the label area will appear on the start side of the field area.
<amx:panelGroupLayout> A panel component that displays its children in a group. It supports horizontal, vertical, and wrap layouts. By default if the children of a panelGroupLayout do not fit into the size of the container, the panel will have scrolling to show the hidden children.
<amx:panelItem> This component represents the content area of a panelSplitter. There must be at least one panelItem defined in each panelSplitter.
<amx:panelLabelAndMessage> This component lays out a label and child component.
<amx:panelPage> Used to define the central area in a page that will scroll up and down between the header and footer areas.
<amx:panelSplitter> This component can be used to show multiple content areas that can be (optionally) controlled by a left-side navigation pane that controls a right-side content pane.
<amx:popup> The popup component is an invisible container control whose contents will be used in popup windows, such as context menus, note windows, dialogs and popup selectors. These types of "popup windows" are within the same browser window and using layers of HTML to simulate an external browser window.
<amx:rowLayout> A rowLayout component is used to define a row of a tableLayout. It contains a series of cellFormat components.
<amx:selectBooleanCheckbox> A component which allows the end user to select a checkbox.
<amx:selectBooleanSwitch> A component which allows the end user to select a boolean value with a switch.
<amx:selectItem> The selectItem tag represents a single item that the user may select from a choice component.
<amx:selectItems> The selectItems tag represents items that the user may select from a choice component.
<amx:selectManyCheckbox> The selectManyCheckbox component creates an inline list of selectable items, which allows the user to select multiple values from the list of items.
<amx:selectManyChoice> The selectManyChoice component creates a single control that, when selected, pops up a list of selectable items, which allows the user to select multiple values from the list of items that are returned as comma separated values into the control.
<amx:selectOneButton> This component groups buttons together visually, either vertically or horizontally.
<amx:selectOneChoice> The selectOneChoice component creates a menu-style component, which allows the user to select a single value from a list of items.
<amx:selectOneRadio> A component which allows the end user to select a single value from a list of available options.
<amx:setPropertyListener> The setPropertyListener tag is a declarative way to allow properties to be set either when an action happens or a value is changed. This component is meant to be a child component of any tag that has some kind of listener attribute like actionListener, or valueChangeListener, etc. The type attribute defines which listener of the parent this actionListener should be fired for. The setPropertyListener fires before the listener on the parent component fires.
<amx:showPopupBehavior> This tag is a declarative way to show an amx:popup. When the showPopupBehavior tag is associated with a component, the popup specified via the popupId attribute will automatically be shown when the action event is activated.
<amx:spacer> Used anywhere to add spacing between items.
<amx:tableLayout> A tableLayout is a thin wrapper around the HTML table element. It contains a series of rowLayout components which in turn contain a series of cellFormat components. It is important to note that a table layout structure does not allow cell contents to use percentage heights nor can a height be assigned to the overall table structure as a whole. For more detail, refer to the "layout", "width", and "height" documentation for the various table layout components.
<amx:uiComponent> This is a placeholder representing any UI component. This component will not be used directly by users, but can be substituted with any UI component.
<amx:validationBehavior> Defines what validationGroup should be validated before a command component's action is taken. Multiple child validationBehavior tags may exist below a command component.
<amx:validationGroup> Defines what components should be grouped together for form validation purposes when doing a "submit" type of operation.
<amx:verbatim> Allows the developer to place any content directly into the markup.
<amx:view> The view component represents a single page in an application.

Dvt Components

NameDescription
<dvtm:area> An area is used to stamp out stylistic attributes such as colors and patterns onto areas of a map component.
<dvtm:areaChart> A DVT Mobile AMX area chart. An area chart is one in which data is represented as lines with the area underneath them filled in.
<dvtm:areaDataLayer> Provides the ability to associate different regions in a areaLayer with a row of data. Each row can be shown as a colored area or marker through stamping.
<dvtm:areaLayer> Used to customize which layers are displayed for a given basemap where each area layer points to a layer from the basemap, i.e. "countries" or "states". Data is associated with a basemap layer by nesting the appropriate data layer within an area layer.
<dvtm:areaLocation> Specifies the column in the data layer's model that determines the location fo the area data. These locations are the area names that join with the area names in the basemap layer.
<dvtm:attributeGroups> Attribute groups.
<dvtm:axisLine> Axis line.
<dvtm:barChart> A DVT Mobile AMX bar chart. A bar chart is one in which data is represented as series of bars.
<dvtm:bubbleChart> A DVT Mobile AMX bubble chart. A bubble chart is one in which data is represented as bubbles where each bubble is defined in terms of three numeric values.
<dvtm:chartDataItem> Chart data item.
<dvtm:comboChart> A DVT Mobile AMX combination chart. A combination chart is one in which data is represented as combination of bar or line markers.
<dvtm:dialGauge> Dial gauge is used to measure small linear distances. Its name is based on the fact that the measurement results are displayed by means of a dial.
<dvtm:gaugeLabelFormat> Gauge label value formatter.
<dvtm:geographicMap> A DVT Mobile AMX georgraphic map.
<dvtm:horizontalBarChart> A DVT Mobile AMX horizontal bar chart. A bar chart is one in which data is represented as series of horizontal bars.
<dvtm:ledGauge> A DVT Mobile AMX LED gauge. LED gauge indicates its value mainly by its color. It changes its color to match the threshold range into which the metric value falls.
<dvtm:legend> The chart legend.
<dvtm:legendSection> The section of a multi-section legend.
<dvtm:lineChart> A DVT Mobile AMX line chart. A line chart is one in which data is represented as lines.
<dvtm:majorTick> Major tick.
<dvtm:marker> A marker is used to stamp out built-in or custom shapes associated with data points on a map component. Markers can be customized with different stylistic attributes such as colors and patterns based on their underlying data. Geographic map marker only supports action, shortDesc, and source attributes.
<dvtm:minorTick> Minor tick.
<dvtm:pieChart> A DVT Mobile AMX pie chart. In a pie chart one group of data is represented as sections of a circle, making the circle look like a sliced pie. Can be used to represent percentages of a whole.
<dvtm:pieDataItem> Pie data item.
<dvtm:pieValueFormat> Pie Value Format.
<dvtm:pointDataLayer> The pointDataLayer allows developers to display data associated with a point on the map using a marker. The point can be a specified by city id for a built-in basemap or x/y coordinates which coorespond to latitude/longitude for built-in basemaps.
<dvtm:pointLocation> Specifies the columns in the data layer's model that determine the location of the data points. For thematic map, these locations can be names that join with named points or latitude/longitude for built-in basemaps, x/y coordinates for custom basemaps. For geographic map, they can be x/y coordinates or an address.
<dvtm:referenceObject> Reference object for an axis.
<dvtm:scatterChart> A DVT Mobile AMX scatter chart. A scatter chart represents data by the location of data markers. Scatter charts are useful for displaying general relationships among a number of data points.
<dvtm:seriesStyle> Series style definition.
<dvtm:sliceLabel> Slice label for pie slice.
<dvtm:sparkChart> A DVT Mobile AMX spark chart. Spark charts are simple, condensed charts that display trends or variations, often in the column of a table. Spark charts are often displayed in a dashboard to provide additional context to a data-dense display.
<dvtm:sparkDataItem> Spark data item.
<dvtm:statusMeterGauge> A DVT Mobile AMX status meter gauge. Status meter gauge indicates its value by its color and area. It changes its color and area to match the threshold range into which the metric value falls.
<dvtm:thematicMap> A DVT Mobile thematic map which is used for displaying spatial trends or patterns in data.
<dvtm:threshold> Gauge threshold.
<dvtm:tickLabel> Tick label for the axis.
<dvtm:xAxis> X axis.
<dvtm:xFormat> X Format.
<dvtm:y2Axis> Y2 axis.
<dvtm:y2Format> Y2 Format.
<dvtm:yAxis> Y axis.
<dvtm:yFormat> Y Format.
<dvtm:zFormat> Z Format.

Skins Components

NameDescription
<skin:adfmf-skins> The root element defined in the adfmf-skins document.
<skin:default> true if this skin is the default skin for the specified skin family. The default skin will be picked if the adfmf-config's skin-version is not set or it is set to "default".
<skin:extends> The id of the parent skin which this custom look and feel extends.
<skin:family> A name which identifies the skin family to which this skin implementation belongs.
<skin:id> A string identifier which uniquely identifies this custom skin implementation.
<skin:name> Defines a skin version name.
<skin:skin> Defines a skin.
<skin:skin-addition> Defines a skin addition. A skin addition which is created by custom component developers to add skinning information for the custom component.
<skin:skin-id> A string identifier which uniquely identifies the skin you are pushing your styles into.
<skin:style-sheet-name> The name of the style sheet which defines the styles for this skin addition.
<skin:version> The version of the skin, if any.

Config Components

NameDescription
<config:adfmf-config> The adfmf-config element is the root element of all adfmf-config.xml files.
<config:skin-family> The skin-family element is used to pick a skin during render. You can optionally add the skin-version to pick a particular version of a skin with the same skin-family.
<config:skin-version> The skin-version element is used to pick a skin during render. A skin is picked by matching the skin-id (required), and if specified here, the skin-version.


Tag name: <adfmf:amx>

Definition for the amx page.

Attributes

NameTypeRequired?Supports EL?Description
filestring No No The file reference for the amx page to be used for this content.

Child Elements

None.


Tag name: <adfmf:application>

Definition for the application. The application is the container that surfaces the included features. Attributes: id - unique id for the application name - human-readable name for the application (should be a RB token) vendor - company/team name of the implementing application version - version of the application Elements: description - a short but detailed description of the application and its purpose. error - stanza to define handlers for given error conditions featureReference - since many features can be bundled with application or Feature Archive the feature reference is used to denote which features are relevant (or can be exposed) by this application. preferences - preferences exposed by the application. navigation - navigation settings for the application. login - login page settings for the application.

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No A unique identifier for the application. This is usually a Java package style identifier, for example: com.company.application.
namestring Yes No The name of the application.
vendorstring No No An optional field identifying the maker of the application.
versionstring No No An optional field identifying a version for the application.
listener-classstring No No Application start/stop/activate/deactivate event listener java class definition.
appControllerFolderstring No No The attribute specifies the name of Application Controller Project folder.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:loadBundle> 01
<adfmf:description> 01
<adfmf:featureReference> 0unbounded
<adfmf:preferences> 01
<adfmf:error> 01
<adfmf:navigation> 01
<adfmf:login> 01
<adfmf:remoteURLWhiteList> 01


Tag name: <adfmf:description>

A description of the application.

Attributes

None.

Child Elements

None.


Tag name: <adfmf:domain>

The domain element is used to define an allowable domain inside ADF Mobile Framework. The domain can contain wildcards.

Attributes

None.

Child Elements

None.


Tag name: <adfmf:error>

Registration for global exception handler page.

Attributes

None.

Child Elements

None.


Tag name: <adfmf:featureReference>

Definition for the feature reference. id - is the associated feature id index - is the position it should initially show up in showOnSpringboard - denotes if the feature should be shown on the springboard showOnNavigationBar - denotes if the feature should be shown on the navigation bar NOTE: if showOnSpringboard and showOnTabControl are both set to false there are only two ways for the feature to show up: 1. if it is the lowest index'ed feature, hence show up on startup 2. a feature does an explicit "GOTO" feature call to it.

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No The feature id of the ADF Mobile feature to include in the application.
showOnSpringboardboolean No No Indicates whether or not the feature should be shown in the default springboard ui.
showOnNavigationBarboolean No No Indicates whether or not the feature should be shown in the navigator bar ui.
loginConnRefIdstring No No Indicates an ADF Mobile Login Server Connection in connections.xml to be used for the feature authentication. This overrides the application default login connection.
allowDeviceAccessboolean No No Indicates whether or not the feature has access to the device via PhoneGap calls.

Child Elements

None.


Tag name: <adfmf:loadBundle>

An additional resource to be made available to the application, ostensibly for localizing applicaiton name, preferences, etc.

Attributes

NameTypeRequired?Supports EL?Description
basenamestring Yes No The path to the resource bundle to be included.
varstring Yes No A name with which the features may reference the loaded resources.

Child Elements

None.


Tag name: <adfmf:localHTML>

Definition for the local HTML page.

Attributes

NameTypeRequired?Supports EL?Description
urlstring No No A project relative path to the local HTML file to be used for this content.

Child Elements

None.


Tag name: <adfmf:login>

Login page setting.

Attributes

NameTypeRequired?Supports EL?Description
defaultConnRefIdstring No No Indicates a ADF Mobile Login Server Connection in connections.xml to be used for default feature authentication.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:localHTML> 01


Tag name: <adfmf:navigation>

Definition for the application navigation.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:navigationBar>
<adfmf:springboard>


Tag name: <adfmf:navigationBar>

Navigation bar setting.

Attributes

NameTypeRequired?Supports EL?Description
enabledboolean No No Indicates whether or not the navigation bar is showed at the application launch. Default is true.
displayHideShowNavigationBarControlboolean No No Indicates whether or not to show the navigation bar hide/show toggle button. Default is false.

Child Elements

None.


Tag name: <adfmf:remoteURLWhiteList>

The remoteURLWhiteList element is used to define a list of domains that can be launched inside ADF Mobile Framework. The domains can be defined as absolute domain or with wildcards, for e.g. "*.oracle.com". A domain entry with value "*" means all domains are allowed.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:domain> 0unbounded


Tag name: <adfmf:springboard>

Springboard setting.

Attributes

NameTypeRequired?Supports EL?Description
enabledboolean No No Indicates whether or not a springboard is enabled. Default is false, or not enabled.
displayGotoSpringboardControlboolean No No Indicates whether or not to show the goto-springboard button/menu item. Default is false.
showSpringboardAtStartupboolean No No Indicates whether or not a springboard is showed at the application launch. Default is true.
animationanimationType No No Indicates whether or not a springboard should slide out from left to right with animation. Default is slideright.
widthwidthType No No Defines the slide-out width of the springboard in pixels.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:springboardFeatureReference> 01


Tag name: <adfmf:springboardFeatureReference>

The springboard reference definition is used to denote which feature should be used as the springboard feature.

Attributes

NameTypeRequired?Supports EL?Description
idstring Yes No The feature id of the ADF Mobile feature that is used as the springboard.

Child Elements

None.


Tag name: <adfmf:amx>

Definition for the amx view/taskflow.

Attributes

NameTypeRequired?Supports EL?Description
fileNonEmtpyString No No The file reference for the amx page or taskflow to be used for this content.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:includes> 01


Tag name: <adfmf:constraint>

The constraint element is a child element of the constraints stanza. It is used to define one of the conditions that must be 'ANDed' together to determine if the constraint is satisfied.

Attributes

NameTypeRequired?Supports EL?Description
propertyPropertyType Yes No The property on which the constraint evaluation is based.
operatorOperatorType Yes No The operation to use in the constraint evaluation.
valuestring Yes No The value to use in the constraint evaluation.

Child Elements

None.


Tag name: <adfmf:constraints>

The constraints element is used to determine if the outter element should be included. In order for a 'constraint' to be satisfied ALL of the constraints must evaluate to being true.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:constraint> 0unbounded


Tag name: <adfmf:content>

Definition for the feature content. This content can be ONE of the following forms: - localHTML - local html view - remoteURL - remote html view - nativeview - local view built with native code - amx - local ADF Mobile view or taskflow for ADF mobile views

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No A unique identifier for this content block.
iconstring No No A project relative path to an icon to be used with this feature. If this property is specified, this value will override the feature-level property of the same name.
imagestring No No A project relative path to an image to be used with this feature. If this property is specified, this value will override the feature-level property of the same name.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:constraints> 01
<adfmf:localHTML> 11
<adfmf:remoteURL> 11
<adfmf:nativeview> 11
<adfmf:amx> 11


Tag name: <adfmf:description>

A description of the ADF Mobile feature.

Attributes

None.

Child Elements

None.


Tag name: <adfmf:feature>

Definition for the feature. Features are application bundles containing all the information needed to be included in the container application. Since each feature is developed independently from each other, this metadata is required to describe the feature to the framework. id - unique id for the feature name - human readable name for the feature (should be a RB token) icon - used to be displayed in the feature tab control image - used to be displayed in the springboard control credentials - the minimum credentail validation policy that must be used. listener-class - lifecycle listener class (if present) interface LifecycleListener defines three methods: 1. activated() - called when a feature is activated 2. deactivated() - called when a feature is deactivated 3. handlePushEvent() - called to process a push event NOTE: features are activated via; - human selection of the feature - programmatically transitioned to the feature - push notification event comes in vendor - company/team name of the implementing feature version - version of the feature

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No A unique identifier for the ADF Mobile feature.
namestring No No A name for the feature.
iconstring No No A project relative path to an icon resource to use for this feature in the navigation bar.
imagestring No No A project relative path to an image resource to use for this feature in the springboard UI.
credentialsCredentialType No No Identifies the type of credentials to use with this feature.
listener-classstring No No A Java class reference for this feature's event listeners.
vendorstring No No The maker of this feature.
versionstring No No A version identifier for this feature.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:constraints> 01
<adfmf:description> 01
<adfmf:content> 0unbounded
<adfmf:preferences> 01


Tag name: <adfmf:features>

A set of ADF Mobile features.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:loadBundle> 01
<adfmf:feature> 0unbounded


Tag name: <adfmf:hint>

A hint.

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId No No A unique identifier for the hint.
categoryHintCategory No No A category value for the hint.
typestring No No A type value for the hint.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:description> 01


Tag name: <adfmf:include>

The constraint element is a child element of the constraints stanza. It is used to define one of the conditions that must be 'ANDed' together to determine if the constraint is satisfied.

Attributes

NameTypeRequired?Supports EL?Description
typeIncludeType Yes No Identifies the type of include. Valid values: JavaScript; StyleSheet
filestring No No The file reference for javascripts or cascade style sheets for amx pages.

Child Elements

None.


Tag name: <adfmf:includes>

The includes element is used to include javascripts or cascade style sheets for an amx element.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:include> 0unbounded


Tag name: <adfmf:loadBundle>

An additional resource to be made available to the features, ostensibly for localizing feature icons, images, and names.

Attributes

NameTypeRequired?Supports EL?Description
basenamestring Yes No The path to the resource bundle to be included.
varstring Yes No A name with which the features may reference the loaded resources.

Child Elements

None.


Tag name: <adfmf:localHTML>

Definition for the loacl HTML view.

Attributes

NameTypeRequired?Supports EL?Description
urlNonEmtpyString No No A project relative path to the local HTML file to be used for this content.

Child Elements

None.


Tag name: <adfmf:nativeview>

Definition for the native view.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:parameter> 0unbounded


Tag name: <adfmf:parameter>

Parameter used by content types to pass standard data in.

Attributes

NameTypeRequired?Supports EL?Description
namestring No No A name for the parameter being passed.
valuestring No No The value of the parameter being passed.

Child Elements

None.


Tag name: <adfmf:remoteURL>

Definition for the remote URL view.

Attributes

NameTypeRequired?Supports EL?Description
connectionNonEmtpyString No No A URL connection reference to the remote content to be used for this feature content.
showNavButtonsboolean No No Indicates whether the browser navigation controls will be shown for features containing remote URLs. If set to true, a navigation bar with Back/Forward/Refresh will be displayed, otherwise this navigation bar will not appear. The default is false.

Child Elements

None.


Tag name: <adfmf:preferenceBoolean>

A boolean preference setting.

Attributes

NameTypeRequired?Supports EL?Description
defaultboolean No No A default value to use with this preference setting.
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

None.


Tag name: <adfmf:preferenceGroup>

Preference group element.

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

None.


Tag name: <adfmf:preferenceList>

A preference setting that gives the user a set of specific items to choose from.

Attributes

NameTypeRequired?Supports EL?Description
defaultstring No No A default value to use with this preference setting.
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:preferenceValue> 0unbounded


Tag name: <adfmf:preferenceNumber>

A number preference setting.

Attributes

NameTypeRequired?Supports EL?Description
defaultdecimal No No A default value to use with this preference setting.
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

None.


Tag name: <adfmf:preferencePage>

Preference page element.

Attributes

NameTypeRequired?Supports EL?Description
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:preferenceGroup> 1unbounded


Tag name: <adfmf:preferences>

Top level application preference element.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<adfmf:preferenceGroup> 0unbounded


Tag name: <adfmf:preferenceText>

A text preference setting.

Attributes

NameTypeRequired?Supports EL?Description
defaultstring No No A default value to use with this preference setting.
secretboolean No No Indicates whether the text in the preference setting should be masked from the user when viewing and editting.
idadfmfComponentId Yes No A unique identifier for the preference setting.
labelstring No No The text to show next to the preference setting field in the preference UI.

Child Elements

None.


Tag name: <adfmf:preferenceValue>

A list item for a preferenceList setting.

Attributes

NameTypeRequired?Supports EL?Description
namestring Yes No A user visible name for the list item.
valuestring Yes No The value associated with this list item.

Child Elements

None.


Tag name: <amx:actionListener>

This component allows you to declaratively invoke an action. This component is meant to be a child component of any tag that has some kind of listener attribute like actionListener, or valueChangeListener, etc. The type attribute defines which listener of the parent this actionListener should be fired for. These methods fire before the listener on the parent component fires.

Attributes

NameTypeRequired?Supports EL?Description
bindingstringElType No Yes EL that defines what should be called when this action occurs.
typestringElType No Yes The type attribute defined which listener of the parent this actionListener should be fired for. For example, the type variable here would be "Action" if the parent was a commandButton or "Value Change" if the parent was an inputText.

Child Elements

None.


Tag name: <amx:carousel>

The carousel component displays a spinning series of items based on rows of a collection model.

Attributes

NameTypeRequired?Supports EL?Description
varstring No No Specifies the name of an attribute under which the resource bundle will be exposed as a Map.
orientationlayoutType No Yes Horizontal (the default) for the images being displayed along an x-axis or vertical for y-axis.
displayItemsdisplayItemsType No Yes The current carousel item will always be shown but you can use this attribute to specify how the auxiliary carousel items are displayed. Use "circular" if you want the auxiliary items displayed near the current item in a scaled down pattern with as many items shown as will fit. Use "oneByOne" if you only want the current item shown.
controlAreacontrolAreaType No Yes Specifies how the area where the user spins the carousel is presented. The "full" option lets a user spin through carousel items one at a time, jump to a specific item, or drag the slider thumb to continuously spin the carousel until the mouse is let go. The "small" option lets a user click the next and previous buttons to spin through carousel items one at a time. The "compact" option is similar to "small" but omits details such as the "x of y" progress information. The "none" option provides no control area at all.
auxiliaryOffsetfloatElType No Yes The offset shift factor that a carousel item will have relative to its nearest item towards the current carousel item in circular displayItems mode. This is the distance an auxiliary item will be moved from its nearest item towards the current item (the distance is the size of the next nearest item multiplied by this offset factor).
auxiliaryPopOutauxiliaryPopOutType No Yes Whether mouse movements within the auxiliary item area of the carousel in circular displayItems mode causes the auxiliary items to be scaled to match the current carousel item.
auxiliaryScalefloatElType No Yes The size scaling factor that a carousel item will have relative to its nearest item towards the current carousel item in circular displayItems mode. A value of 1 means the auxiliary items will all be the same size. A value less than 1 means the auxiliary items will become smaller the further they are from the current item. A value greater than 1 means the auxiliary items will become larger the further they are from the current item. Note that regardless of item size, the current carousel item is the only item that is interactive; clicking on an auxiliary item will only spin the carousel.
halignhalignType No Yes Determines the horizontal alignment of the carousel items.
valignvalignType No Yes Determines the vertical alignment of the carousel items.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 01


Tag name: <amx:carouselItem>

The carouselItem component must be placed inside of a carousel component's "nodeStamp". It represents an item inside of a carousel component and its text attribute will be displayed when it is the current item the carousel. Although the most common child of carouselItem is image, other components may be used. For example you might use a commandLink as a child that surrounds an image. In order to minimize any negative effect on performance, you should avoid using any heavy-weight children because as you add more complexity to the structure, the effect will be multiplied because several carouselItem stamps will be displayed simultaneously.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
textstringElType No Yes Specifies the textual label of the component.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 11


Tag name: <amx:cellFormat>

A cellFormat component is used to define a cell in a rowLayout of a tableLayout.

Attributes

NameTypeRequired?Supports EL?Description
columnSpanintegerElType No Yes The number of cells wide the child layout element will be (must be a number 1 or greater).
halignhalignType No Yes The horizontal alignment of the grid row elements. Valid values: start (default), end, center.
headerbooleanElType No Yes Indicates whether or not this table cell is a header cell or a data cell. Setting this attribute to 'true' will mark this cell as a header cell.
heightstringElType No Yes The preferred height of the cell (cannot use percentage units, cell contents and other cells in this cell's row may override this value).
rowSpanintegerElType No Yes The number of cells high the child layout element will be (must be a number 1 or greater).
valignvalignType No Yes The vertical alignment of the grid row elements. The acceptable values are "middle" (default), "top", and "bottom".
widthstringElType No Yes The preferred width of the cell (cell contents and other cells in this cell's column may override this value).
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
renderedbooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:validationGroup> 01


Tag name: <amx:closePopupBehavior>

This tag is a declarative way to hide an amx:popup. When the closePopupBehavior tag is associated with a component, it can hide the popup on some user action.

Attributes

NameTypeRequired?Supports EL?Description
popupIdstringElType No Yes Specifies the ID of the popup that will be hidden.
typestringElType No Yes This attribute defines when the popup will be dismissed. Valid values are: action (default), swipeDown, swipeLeft, swipeRight, swipeUp, tapHold.

Child Elements

None.


Tag name: <amx:commandButton>

The commandButton component creates a button that, when pressed, will generate an action event. The button can contain text, an image, or both text and an image.

Attributes

NameTypeRequired?Supports EL?Description
iconstringElType No Yes Defines the location of an image resource to use as an icon displayed on the button. The image file must be included in the project and be specified by its relative location in the project. This attribute can be specified as static text, EL Expression, or a combination of both.
iconPositioniconPositionType No Yes Specifies the position of the icon. Valid values: leading (icon is left of text); trailing (icon is right of text).
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.
actionListenerelExpression No YesDefines a method reference to an action listener.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
textstringElType No Yes Specifies the textual label of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:actionListener> 0unbounded
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <amx:commandLink>

The commandLink component creates a link that, when pressed, will generate an action event. It may also contain a child image component to create a link that displays an image rather than text.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.
actionListenerelExpression No YesDefines a method reference to an action listener.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
textstringElType No Yes Specifies the textual label of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:actionListener> 0unbounded
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <amx:convertDateTime>

Converts string into java.util.Date and vice versa based on the pattern and style set.

Attributes

NameTypeRequired?Supports EL?Description
dateStyleconvertDateTimeStyleType No Yes Specifies the predefined formatting style that determines how the date component of a date string is to be formatted and parsed. Applied only if type is set to "date" or "both". Valid values: default, full, long, medium, short (default).
patternstringElType No Yes Specifies a custom formatting pattern that determines how the date/time string should be formatted and parsed. The syntax must conform to the rules specified by java.text.SimpleDateFormat.
timeStyleconvertDateTimeStyleType No Yes Specifies the predefined formatting style that determines how the time component of a date string is to be formatted and parsed. Applied only if the type is "time" or "both". Valid values: default, full, long, medium, short (default).
typeconvertDateTimeType No Yes Specifies what content the string value will be formatted to include, or parsed. Valid values: date (default), time, both.

Child Elements

None.


Tag name: <amx:convertNumber>

This is an extension of the standard JSF javax.faces.convert.NumberConverter. The converter provides all the standard functionality of the default NumberConverter and is strict while converting to object.

Attributes

NameTypeRequired?Supports EL?Description
currencyCodestringElType No Yes Specifies the ISO 4217 currency code, and is only applied when formatting currencies.
currencySymbolstringElType No Yes Specifies the currency symbol, and is only applied when formatting currencies. If the currencyCode attribute is set, then currencySymbol will be ignored.
groupingUsedbooleanElType No Yes Specifies whether or not the formatted output will contain grouping separators. The default value is true.
integerOnlybooleanElType No Yes Specifies whether or not only the integer part of the value will be formatted and parsed. Default value is false.
maxFractionDigitsintegerElType No Yes Specifies the maximum number of digits that will be formatted in the fractional portion of the output.
maxIntegerDigitsintegerElType No Yes Specifies the maximum number of digits that will be formatted in the integer portion of the output.
minFractionDigitsintegerElType No Yes Specifies the minimum number of digits that will be formatted in the fractional portion of the output.
minIntegerDigitsintegerElType No Yes Specifies the minimum number of digits that will be formatted in the integer portion of the output.
typeconvertNumberType No Yes Specifies what content string value will be formatted to include, or parsed. Valid values: number (default), currency, percent.

Child Elements

None.


Tag name: <amx:facet>

Defines an arbitrarily named facet on the parent component. The position and rendering of the facet are determined by the parent component.

Attributes

NameTypeRequired?Supports EL?Description
namestring Yes No The name of the facet. All possible facets for a component need to be itemized on the component itself.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> unbounded


Tag name: <amx:goLink>

This component creates a simple anchor tag that does not follow any task flow navigation and is meant for performing external links to other pages or operations such as making a call.

Attributes

NameTypeRequired?Supports EL?Description
urlstringElType No Yes Specifies the url to be used for this link. This can be an external url starting with "http://" or something more native like "tel:" to dial the phone.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
textstringElType No Yes Specifies the textual label of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:image> 01


Tag name: <amx:image>

The image component displays an image.

Attributes

NameTypeRequired?Supports EL?Description
shortDescstringElType No Yes The short description is used to render an HTML alt attribute for the image. The short description property value should be set to provide basic accessibility.
sourcestringElType No Yes This attribute can be specified as either a URI to a file or the data for the image itself. If this is a path to an image starting with a "/" it is relative to the root of the web-content folder, otherwise it will start relative to the current AMX file. The source can also start with "file://", in which case it will go to the current file system on the device. The source can also contain a base64 encoded image data instead of a URI to a file. This attribute can be specified as static text, EL expression or a combination of both.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

None.


Tag name: <amx:inputDate>

Renders an input field for dates.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs.
inputTypedateInputType No Yes Determines whether inputDate displays date, time, or datetime.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

None.


Tag name: <amx:inputNumberSlider>

Creates a numeric input component. It is used to enter numbers and it has a slider to quickly increment or decrement the number.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value must resolve to an integer for this component.
minimumintegerElType No Yes Specifies the minimum number allowed in the input field.
maximumintegerElType No Yes Specifies the maximum number allowed in the input field.
stepSizeintegerElType No Yes Specifies the step size by which the spinbox will increase increase or decrease the number in the input. This is an integre value.
imageLeftstringElType No Yes The image to place on the left side of the slider component.
imageRightstringElType No Yes The image to place on the right side of the slider component.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <amx:inputText>

An input text field component.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onBlur occurs.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onBlur occurs and after the model is updated.
hintTextstringElType No Yes Text fields may contain default text, typically used as a prompt. When the user taps a key on the keyboard in a field that contains default text, the text should clear when Edit mode is entered.
maximumLengthintegerElType No Yes Specifies the maximum number of characters that can be entered into the text component. This includes the characters representing the new line. If set to 0 or less, the maximumLength is ignored.
rowsintegerElType No Yes Defines the height of the text component specified by the number of characters shown. The default is 1, which generates a one-row input field. The number of rows is estimated based on the default font size of the device.
secretbooleanElType No Yes Defines a boolean value that only applies to single line text components. When set to TRUE, it hides the actual value of the text from the end user, and will prevent the actual value from being shown to the end user. When the end user manually enters a value, each character will appear as an asterisk(*). If secret is set to TRUE, be sure to not use a converter or validator tag with this InputText, which would expose the value the user entered via its messages.
inputTypetextInputType No Yes Sets the type of data that the user should be allowed to provide. If secret has been set to true or if the rows attribute has been set to larger than 1, the input type will be treated as "text". This will not guarantee an input format nor prevent the user from entering other types of characters, it only serves as a mechanism to request that the mobile device present the user with an optimized input mechanism for a particular type of input value (e.g. a virtual keyboard with numbers primarily displayed).
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertDateTime> 01
<amx:convertNumber> 01


Tag name: <amx:iterator>

The iterator is a component that does iteration. It is similar to listView but has no chrome.

Attributes

NameTypeRequired?Supports EL?Description
varstring No No Specifies the name of an attribute under which the resource bundle will be exposed as a Map.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 1unbounded


Tag name: <amx:listItem>

Represents a single row of a listView.

Attributes

NameTypeRequired?Supports EL?Description
showLinkIconbooleanElType No Yes Whether to show a link icon for this row or not. Normally the icon is at the right of the row. Example is a chevron. Values are true/false, default is true.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.
actionListenerelExpression No YesDefines a method reference to an action listener.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:actionListener> 0unbounded
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <amx:listView>

An iteration component that provides the look and feel of rows with range capabilities.

Attributes

NameTypeRequired?Supports EL?Description
varstring No No Specifies the name of an attribute under which the resource bundle will be exposed as a Map.
dividerAttributestringElType No Yes This is a string that defines the property name that will be used to determine what the list divider will be and when it changes. A new divider will be inserted whenever the value of the property defined in dividerAttribute changes. The scope of the change depends on the value of the dividerMode property.
dividerModedividerModeType No Yes How the attribute defined by dividerAttribute will be interpreted. Valid values are: firstLetter, all. Default is all.
editModebooleanElType No Yes Defines whether the list should be in edit mode or not. In edit mode, the rows of the list can be moved and reordered. The default is false.
moveListenerelExpression No YesDefines a method reference to a move listener that will be called when a row of the list is moved and dropped to a new location. The key of the row moved and the key of the row it is being placed before (or null if at the end) is sent as a parameter to the listener.
collapsibleDividersbooleanElType No Yes Indicates whether dividers can be collapsed. Default is false.
collapsedDividersstringElType No Yes This is an array of divider strings that should start collapsed. These divider strings match the values in the dividerAttribute element of the collection.
showDividerCountbooleanElType No Yes Defines whether counts should be displayed on each divider. Default is false.
fetchSizenonZeroIntegerElType No Yes Controls how many rows to initially display in a listView and how many rows to get when the app user clicks on the "Load More Rows" row.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valuestringElType No Yes The value of the component.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:listItem> 1unbounded
<amx:facet> 1unbounded


Tag name: <amx:loadBundle>

Loads a resource bundle localized for the Locale of the current view.

Attributes

NameTypeRequired?Supports EL?Description
basenamestringElType No Yes Specifies the base name of the resource bundle to be loaded.
varstring No No Specifies the name of an attribute under which the resource bundle will be exposed as a Map.

Child Elements

None.


Tag name: <amx:outputText>

Presents text data in a read-only manner.

Attributes

NameTypeRequired?Supports EL?Description
truncateAtintegerElType No Yes Specifies the length at which the text should automatically begin truncating. When set to zero (the default), the string will never truncate. Values from 1 to 15 will display the first 12 characters followed by an ellipsis (...). The component will not truncate strings shorter than 15 characters. For example, for the value of 1234567890123456, setting truncateAt to 0 or 16 will not truncate. Setting truncateAt to any value between 1 and 15 will truncate to '123456789012...'.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valuestringElType No Yes The value of the component.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertDateTime> 01
<amx:convertNumber> 01


Tag name: <amx:panelFormLayout>

Within the Panel Form Layout, the label area can either be displayed on the start side of the field area or on a separate line above the field area. Separate lines are used if the "labelPosition" attribute is set to "topStart", "topCenter", or "topEnd". Otherwise the label area will appear on the start side of the field area.

Attributes

NameTypeRequired?Supports EL?Description
labelWidth No No Specifies the width of the labels. The framework enforces this dimension unless it cannot fit in the space allocated by the parent. You may define the labelWidth in pixels or as a percentage. The units used for this value must be identical to the units used in the fieldWidth value. If a labelWidth is provided as a percentage, the labelWidth and the fieldWidth should total to 100%. If the labelWidth is not specified, but a fieldWidth is specified as a percentage, the labelWdith will be derived as the appropriate percentage value for you.
fieldWidth No No Specifies the width of the field. The framework enforces this dimension unless it cannot fit in the space allocated by the parent. You may define the fieldWidth in pixels or as a percentage. The units used for this value must be identical to the units used in the labelWidth value. If a fieldWidth is provided as a percentage, the labelWidth and the fieldWidth should total to 100%. If the fieldWdith is not specified, but a label Width is specified as a percentage, the fieldWdith will be derived as the appropriate percentage value for you. Note: The labelWidth has precedence when allocating available space. In a case where both field and label width are specified in pixels and the total is greater than the available width, the field width is cropped to the remaining available width after labelWidth is allocated.
labelPositionlabelPositionType No Yes Within the label area, the "labelPosition" attribute controls where the label text can be aligned: to the start side (labelPosition="start" or "topStart"), to the center (labelPosition="center" or "topCenter"), or to the end side (labelPosition="end" or "topEnd").
fieldHalignhalignType No Yes Within the field area, the "fieldHalign" attribute controls where the field content can be aligned: to the start side (fieldHalign="start"), to the center (fieldHalign="center"), or to the end side (fieldHalign="end").
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
renderedbooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:inputDate> 0unbounded
<amx:inputNumberSlider> 0unbounded
<amx:inputText> 0unbounded
<amx:iterator> 0unbounded
<amx:panelLabelAndMessage> 0unbounded
<amx:selectBooleanCheckbox> 0unbounded
<amx:selectBooleanSwitch> 0unbounded
<amx:selectManyCheckbox> 0unbounded
<amx:selectManyChoice> 0unbounded
<amx:selectOneButton> 0unbounded
<amx:selectOneChoice> 0unbounded
<amx:selectOneRadio> 0unbounded


Tag name: <amx:panelGroupLayout>

A panel component that displays its children in a group. It supports horizontal, vertical, and wrap layouts. By default if the children of a panelGroupLayout do not fit into the size of the container, the panel will have scrolling to show the hidden children.

Attributes

NameTypeRequired?Supports EL?Description
layoutpglLayoutType No Yes Specifies the type of layout. Valid values: horizontal, vertical, wrap. In a horizontal layout, the child components are strictly consecutive without wrapping; they can be aligned vertically and are top aligned by default. Vertical layouts stack components vertically, and the child components can be aligned horizontally; they are left aligned by default. Wrap layout is a consecutive layout as defined by the browser, with wrapping allowed, and following the bidirectional layout algorithm. As a result, in the presence of mixed right-to-left and left-to-right text, contents may not display consecutively.
halignhalignType No Yes The horizontal alignment for horizontal and vertical layouts. This is ignored if "layout" is "wrap". Note that if "layout" is "horizontal", the browsers can only reliably handle horizontal alignment of components that have either fixed widths or that are "inline" such as outputText.
valignpglValignType No Yes The vertical alignment of a horizontal layout. This is ignored if "layout" is not "horizontal".
landmarklandmarkRole No Yes Specifies the WAI-ARIA landmark role for this panelGroupLayout. The landmark property value should be set to provide basic accessibility.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:validationGroup> 01


Tag name: <amx:panelItem>

This component represents the content area of a panelSplitter. There must be at least one panelItem defined in each panelSplitter.

Attributes

NameTypeRequired?Supports EL?Description
animationpanelSplitterAnimationType No Yes This is animation to be used when the content changes. This can be overridden at the panel level.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:validationGroup> 01


Tag name: <amx:panelLabelAndMessage>

This component lays out a label and child component.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
renderedbooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:carousel> 0unbounded
<amx:commandButton> 0unbounded
<amx:commandLink> 0unbounded
<amx:goLink> 0unbounded
<amx:image> 0unbounded
<amx:outputText> 0unbounded
<amx:panelGroupLayout> 0unbounded
<amx:tableLayout> 0unbounded
<amx:spacer> 0unbounded
<amx:verbatim> 0unbounded


Tag name: <amx:panelPage>

Used to define the central area in a page that will scroll up and down between the header and footer areas.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:validationGroup> 01
<amx:uiComponent> 0unbounded
<amx:facet> 0unbounded


Tag name: <amx:panelSplitter>

This component can be used to show multiple content areas that can be (optionally) controlled by a left-side navigation pane that controls a right-side content pane.

Attributes

NameTypeRequired?Supports EL?Description
positionstringElType No Yes The position to place the splitter between the Navigator and the content area. Default is 33%.
selectedItemstringElType No Yes The id of a child panelItem to be rendered.
animationpanelSplitterAnimationType No Yes This is animation to be used when the content changes.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 01
<amx:panelItem> 1unbounded


Tag name: <amx:popup>

The popup component is an invisible container control whose contents will be used in popup windows, such as context menus, note windows, dialogs and popup selectors. These types of "popup windows" are within the same browser window and using layers of HTML to simulate an external browser window.

Attributes

NameTypeRequired?Supports EL?Description
animationpopupAnimationType No Yes The animation to use when displaying this popup. Valid values: slideUp, slideDown, slideRight, slideLeft, pop. Default is pop.
autoDismissbooleanElType No Yes Specifies if the popup can be dismissed if the user taps somewhere outside of the popup. Default is false.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded
<amx:validationGroup> 01


Tag name: <amx:rowLayout>

A rowLayout component is used to define a row of a tableLayout. It contains a series of cellFormat components.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:cellFormat> 1unbounded
<amx:iterator> 1unbounded


Tag name: <amx:selectBooleanCheckbox>

A component which allows the end user to select a checkbox.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value must resolve to a boolean for this component.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
textstringElType No Yes Specifies the textual label of the component.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

None.


Tag name: <amx:selectBooleanSwitch>

A component which allows the end user to select a boolean value with a switch.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value must resolve to a boolean for this component.
offLabelstringElType No Yes The text to be shown when the switch is "off". Typically this is "Off" or "No".
onLabelstringElType No Yes The text to be shown when the switch is "on". Typically this is "On" or "Yes".
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

None.


Tag name: <amx:selectItem>

The selectItem tag represents a single item that the user may select from a choice component.

Attributes

NameTypeRequired?Supports EL?Description
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
valuestringElType No Yes The value of the component.

Child Elements

None.


Tag name: <amx:selectItems>

The selectItems tag represents items that the user may select from a choice component.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes The value of the component.

Child Elements

None.


Tag name: <amx:selectManyCheckbox>

The selectManyCheckbox component creates an inline list of selectable items, which allows the user to select multiple values from the list of items.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value must resolve to an array for this component.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:selectItems> 0unbounded
<amx:selectItem> 0unbounded


Tag name: <amx:selectManyChoice>

The selectManyChoice component creates a single control that, when selected, pops up a list of selectable items, which allows the user to select multiple values from the list of items that are returned as comma separated values into the control.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value must resolve to an array for this component.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:selectItems> 0unbounded
<amx:selectItem> 0unbounded


Tag name: <amx:selectOneButton>

This component groups buttons together visually, either vertically or horizontally.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value attribute contains the button object that is currently highlighted.
layoutlayoutType No Yes Whether the buttons should be shown horizontally or vertically. The default is horizontal.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:selectItems> 0unbounded
<amx:selectItem> 0unbounded


Tag name: <amx:selectOneChoice>

The selectOneChoice component creates a menu-style component, which allows the user to select a single value from a list of items.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:selectItems> 0unbounded
<amx:selectItem> 0unbounded


Tag name: <amx:selectOneRadio>

A component which allows the end user to select a single value from a list of available options.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes Specifies the value of the component. The value in the component will be updated into the object pointed to by the value attribute when onChange occurs. The value attribute contains the radio button object that is currently highlighted.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.
renderedbooleanElType No Yes Whether this component should be rendered or not.
labelstringElType No Yes Defines the label of the component. In order for the label to appear above the component, a PanelFormLayout should be used.
readOnlybooleanElType No Yes Whether this component should be rendered or not.
requiredbooleanElType No Yes Specifies where or not a non-null, non-empty value must be enetered. If set to false, validators will not be excuted when the value is null or empty. If set to true, a visual indication is displayed to notify end user that a value must be entered, otherwise an exception will occur and the component will fail validation.
showRequiredbooleanElType No Yes Defines whether or not the associated component displays a visual indication of the required user input. Both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. For example, this attribute could be used when there is a field that is initially empty and is required only if some other field on the page is modified.
simplebooleanElType No Yes Specifies whether or not the component provides the label support. When set to TRUE, the component will not display the label (label and showRequired properties are ignored) and may use simpler layout primitives. For example, this attribute could be defined when a component is used in a table where label is not required.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:selectItems> 0unbounded
<amx:selectItem> 0unbounded


Tag name: <amx:setPropertyListener>

The setPropertyListener tag is a declarative way to allow properties to be set either when an action happens or a value is changed. This component is meant to be a child component of any tag that has some kind of listener attribute like actionListener, or valueChangeListener, etc. The type attribute defines which listener of the parent this actionListener should be fired for. The setPropertyListener fires before the listener on the parent component fires.

Attributes

NameTypeRequired?Supports EL?Description
fromstringElType No Yes Specifies the source of the value; can be an EL expression or a constant value.
tostringElType No Yes Specifies the target for the value; must be an EL expression.
typestringElType No Yes The type attribute defines which listener of the parent this setPropertyListener should be fired for. For example, the type variable here would be "Action" if the parent was a commandButton or "Value Change" if the parent was an inputText.

Child Elements

None.


Tag name: <amx:showPopupBehavior>

This tag is a declarative way to show an amx:popup. When the showPopupBehavior tag is associated with a component, the popup specified via the popupId attribute will automatically be shown when the action event is activated.

Attributes

NameTypeRequired?Supports EL?Description
alignalignType No Yes Indicates how the popup should be aligned relative to the alignId component. Valid values include: after (default), before, overlapBottom, overlapTop.
alignIdstringElType No Yes Specifies the ID of the component relative to which the popup will be aligned.
popupIdstringElType No Yes Specifies the ID of the popup that will be shown.
typestringElType No Yes This attribute defines when the popup will occur. Valid values are: action (default), swipeDown, swipeLeft, swipeRight, swipeUp, tapHold.

Child Elements

None.


Tag name: <amx:spacer>

Used anywhere to add spacing between items.

Attributes

NameTypeRequired?Supports EL?Description
heightintegerElType No Yes Specifies the height to be used for the spacer. The value will be directly used in the height html style.
widthintegerElType No Yes Specifies the width to be used for the spacer. The value will be directly used in the width html style.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
renderedbooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

None.


Tag name: <amx:tableLayout>

A tableLayout is a thin wrapper around the HTML table element. It contains a series of rowLayout components which in turn contain a series of cellFormat components. It is important to note that a table layout structure does not allow cell contents to use percentage heights nor can a height be assigned to the overall table structure as a whole. For more detail, refer to the "layout", "width", and "height" documentation for the various table layout components.

Attributes

NameTypeRequired?Supports EL?Description
borderWidthintegerElType No Yes The border width around the table and if non-zero adds one around each cell. Typically this is only used for debugging purposes because you can't control the style of the border; using the inlineStyle of the cellFormat gives much greater control.
cellPaddingintegerElType No Yes The spacing within cells.
cellSpacingintegerElType No Yes The spacing between cells.
halignhalignType No Yes The horizontal alignment of the table. Valid values: start (default), end, center.
layouttableLayoutsType No Yes In pure HTML, tables treat cell widths more like suggestions rather than requirements; cell content sizes contribute more in determining the size of each column (this is the "weighted" mode). If you care more for the specified cellFormat widths than content sizes (particularly if your cellFormat widths are percentage-based and your cells have contents that are programmatically-resizable based on the cell width), then you will need to use "fixed" to declare that you want your cell widths to be given priority. Refer to the CSS specification on "table-layout" for further details on fixed and weighted layouts. Valid values: fixed (default), weighted.
summarystringElType No Yes The summary of the table's purpose and structure for user agents rendering to non-visual media. This attribute must be set if this element is being used to implement a data table (instead of a layout table).
widthstringElType No Yes The preferred total width of the table (cell width and contents may override this value).
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
renderedbooleanElType No Yes Whether this component should be rendered or not.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:rowLayout> 1unbounded
<amx:iterator> 1unbounded


Tag name: <amx:uiComponent>

This is a placeholder representing any UI component. This component will not be used directly by users, but can be substituted with any UI component.

<amx:carousel>
<amx:carouselItem>
<amx:cellFormat>
<amx:commandButton>
<amx:commandLink>
<amx:goLink>
<amx:image>
<amx:inputDate>
<amx:inputNumberSlider>
<amx:inputText>
<amx:iterator>
<amx:listView>
<amx:outputText>
<amx:panelFormLayout>
<amx:panelGroupLayout>
<amx:panelLabelAndMessage>
<amx:panelSplitter>
<amx:rowLayout>
<amx:selectBooleanCheckbox>
<amx:selectBooleanSwitch>
<amx:selectManyCheckbox>
<amx:selectManyChoice>
<amx:selectOneButton>
<amx:selectOneChoice>
<amx:selectOneRadio>
<amx:spacer>
<amx:tableLayout>
<amx:verbatim>
<dvtm:area>
<dvtm:areaChart>
<dvtm:areaDataLayer>
<dvtm:areaLayer>
<dvtm:areaLocation>
<dvtm:barChart>
<dvtm:bubbleChart>
<dvtm:chartDataItem>
<dvtm:comboChart>
<dvtm:dialGauge>
<dvtm:geographicMap>
<dvtm:horizontalBarChart>
<dvtm:ledGauge>
<dvtm:lineChart>
<dvtm:marker>
<dvtm:pieChart>
<dvtm:pieDataItem>
<dvtm:pointDataLayer>
<dvtm:pointLocation>
<dvtm:scatterChart>
<dvtm:seriesStyle>
<dvtm:sparkChart>
<dvtm:sparkDataItem>
<dvtm:statusMeterGauge>
<dvtm:thematicMap>


Tag name: <amx:validationBehavior>

Defines what validationGroup should be validated before a command component's action is taken. Multiple child validationBehavior tags may exist below a command component.

Attributes

NameTypeRequired?Supports EL?Description
groupstring No No The identifier for the amx:validationGroup that will be validated.
disabledbooleanElType No Yes Specifies whether or not the component is disabled. Unlike a read-only component, a disabled component cannot receive focus.

Child Elements

None.


Tag name: <amx:validationGroup>

Defines what components should be grouped together for form validation purposes when doing a "submit" type of operation.

Attributes

NameTypeRequired?Supports EL?Description
validateConditionvalidateConditionType No Yes Determines whether or not the group should be validated. "visible" means validate if the group is visible and rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:uiComponent> 0unbounded


Tag name: <amx:verbatim>

Allows the developer to place any content directly into the markup.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
renderedbooleanElType No Yes Whether this component should be rendered or not.

Child Elements

None.


Tag name: <amx:view>

The view component represents a single page in an application.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:panelPage> 11
<amx:loadBundle> 01
<amx:popup> 0unbounded


Tag name: <dvtm:area>

An area is used to stamp out stylistic attributes such as colors and patterns onto areas of a map component.

Attributes

NameTypeRequired?Supports EL?Description
valuestringElType No Yes When labelDisplay is on, this value will be used as the text label for the area.
renderedbooleanElType No Yes Determines if the area should be rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
fillColorcolorElType No Yes Data item fill color.
opacityfloatElType No Yes Opacity of the fill. Valid values are from 0.0-1.0 where 0.0 is transparent and 1.0 is opaque.
labelStylestringElType No Yes Font style for labels associated with this data item. Valid values are font-related CSS attributes.
labelDisplaylabelDisplayElType No Yes Label display. Valid values are: off (default), on.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:attributeGroups> 0unbounded
<amx:convertNumber> 01
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 01
<amx:closePopupBehavior> 01


Tag name: <dvtm:areaChart>

A DVT Mobile AMX area chart. An area chart is one in which data is represented as lines with the area underneath them filled in.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
animationIndicatorsanimationIndicatorsElType No Yes Type of data change animation indicators. Valid values are: all (default), none.
animationDownColorcolorElType No Yes Color used to indicate a decreasing value.
animationUpColorcolorElType No Yes Color used to indicate an increasing value.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
dataCursordataCursorElType No Yes Specifies the data cursor visibility. Valid values are: auto (default), off, on. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting turns the data cursor display on for area and line charts on touch displays. Otherwise, the default is 'off'.
dataCursorBehaviordataCursorBehaviorElType No Yes Specifies the data cursor behavior. Valid values are: auto (default), smooth, snap. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting enables the smooth behavior for area and line charts and snap behavior for other chart types.
stackstackingElType No Yes Specifies whether the chart should be stacked. Applicable to area, bar, horizontalBar, combo and line charts only. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 12
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:y2Axis> 01
<dvtm:yFormat> 01
<dvtm:y2Format> 01


Tag name: <dvtm:areaDataLayer>

Provides the ability to associate different regions in a areaLayer with a row of data. Each row can be shown as a colored area or marker through stamping.

Attributes

NameTypeRequired?Supports EL?Description
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnAreaDataChangeElType No Yes Animation effect when the data changes. Valid values are: none (default), alphaFade, flipLeft, flipRight, cubeToLeft, cubeToRight.
isolatedRowKeyrowKeyListElType No Yes The isolated state of the data layer.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
varstring No No The name of the variable to be used for data item stamping.
renderedbooleanElType No Yes Determines if the area data layer should be rendered.
selectedRowKeysrowKeyListElType No Yes The selection state of the data layer.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:areaLocation> 01


Tag name: <dvtm:areaLayer>

Used to customize which layers are displayed for a given basemap where each area layer points to a layer from the basemap, i.e. "countries" or "states". Data is associated with a basemap layer by nesting the appropriate data layer within an area layer.

Attributes

NameTypeRequired?Supports EL?Description
animationOnLayerChangeanimationOnLayerMapChangeElType No Yes Animation effect when the area layer changes. Valid values are: none (default), alphaFade, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, zoom.
areaLabelDisplayareaLayerLabelDisplayElType No Yes How built-in labels for this layer should be displayed. Valid values are: auto, on, off.
labelTypelabelTypeElType No Yes The type of built-in basemap label to display. Valid values are: short, long.
layerlayerElType No Yes Name of a layer from the built-in basemap. Valid values are listed based by basemap.
  • usa basemap: country, states, counties
  • world basemap: continents, countries
  • worldRegions basemap: regions, countries
  • africa basemap: continent, countries
  • asia basemap: continent, countries
  • australia basemap: continent, countries
  • europe basemap: continent, countries
  • northAmerica basemap: continent, countries
  • southAmerica basemap: continent, countries
  • apac basemap: region, countries
  • emea basemap: region, countries
  • latinAmerica basemap: region, countries
  • usaAndCanada basemap: region, countries
renderedbooleanElType No Yes Determines if the area layer should be rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelStylestringElType No Yes Font style for labels associated with this data item. Valid values are font-related CSS attributes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:areaDataLayer> 0unbounded
<dvtm:pointDataLayer> 0unbounded


Tag name: <dvtm:areaLocation>

Specifies the column in the data layer's model that determines the location fo the area data. These locations are the area names that join with the area names in the basemap layer.

Attributes

NameTypeRequired?Supports EL?Description
namestringElType No Yes Column in the data model that determines the location of the area data. The locations are ids of the area from the basemap area layer for which the data is being displayed. The ids of the areas are determined by the following naming convention:

For the "usa" basemap, the ids are determined by the rules below:

  • The id for the country layer is "USA"
  • For states, the ids are the two letter postal abbreviation (e.g., the id for Massachusetts is "MA" and the id for Texas is "TX")
  • For counties, the ids are the two letter state abbreviation the county is located in, followed by an underscore, and then the name of the county, all in capital letters with underscores replacing spaces (e.g., the id for Middlesex county in Massachusetts is "MA_MIDDLESEX" and the id for Red River county in Texas is "TX_RED_RIVER")

For all other basemaps, the ids are determined by the rules below:

  • The continent ids for the "world", "africa", "asia", "australia", "europe", "northAmerica", and "southAmerica" basemaps are: "AF" (Africa), "AS" (Asia), "AU" (Australia), "EU" (Europe), "NA" (North America), and "SA" (South America).
  • The region ids for the "worldRegions", "apac", "emea", "latinAmerica", and "usaAndCanada" basemaps are: "APAC" (Asia-Pacific), "EMEA" (Europe and the Middle East), "LAT" (Latin America), "NA" (United States and Canada).
  • The country ids are determined by the ISO 3166-1 alpha-3 country codes (e.g., Canada is "CAN" and China is "CHN")

Links to complete lists of the area ids for all basemaps are listed below:

renderedbooleanElType No Yes Determines if the area location should be rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:area> 01
<dvtm:marker> 01


Tag name: <dvtm:attributeGroups>

Attribute groups.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for this attribute group. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
labelstringElType No Yes A human readable label that appears in the legend. Optional. If missing, the 'value' attribute will be used as label.
typestring No No A space separated list of attributes to be set by this attribute group. The supported attributes are 'color' and 'shape'.
valuestringElType No Yes The value (typically an EL string) to group the attributes by.

Child Elements

None.


Tag name: <dvtm:axisLine>

Axis line.

Attributes

NameTypeRequired?Supports EL?Description
lineColorcolorElType No Yes Axis line color.
lineWidthintegerElType No Yes Axis line width.
renderedbooleanElType No Yes Determines if the axis line should be rendered.

Child Elements

None.


Tag name: <dvtm:barChart>

A DVT Mobile AMX bar chart. A bar chart is one in which data is represented as series of bars.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
animationIndicatorsanimationIndicatorsElType No Yes Type of data change animation indicators. Valid values are: all (default), none.
animationDownColorcolorElType No Yes Color used to indicate a decreasing value.
animationUpColorcolorElType No Yes Color used to indicate an increasing value.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
dataCursordataCursorElType No Yes Specifies the data cursor visibility. Valid values are: auto (default), off, on. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting turns the data cursor display on for area and line charts on touch displays. Otherwise, the default is 'off'.
dataCursorBehaviordataCursorBehaviorElType No Yes Specifies the data cursor behavior. Valid values are: auto (default), smooth, snap. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting enables the smooth behavior for area and line charts and snap behavior for other chart types.
stackstackingElType No Yes Specifies whether the chart should be stacked. Applicable to area, bar, horizontalBar, combo and line charts only. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 12
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:y2Axis> 01
<dvtm:yFormat> 01
<dvtm:y2Format> 01


Tag name: <dvtm:bubbleChart>

A DVT Mobile AMX bubble chart. A bubble chart is one in which data is represented as bubbles where each bubble is defined in terms of three numeric values.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 11
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:xFormat> 01
<dvtm:yFormat> 01
<dvtm:zFormat> 01


Tag name: <dvtm:chartDataItem>

Chart data item.

Attributes

NameTypeRequired?Supports EL?Description
borderColorcolorElType No Yes Border color of this item.
colorcolorElType No Yes Fill color of this item. Specifies the color of a bar or the data point. For line and area chart types, markerDisplayed must be enabled to make the marker visible.
groupstringElType No Yes Group category of this item (if set).
groupIdstringElType No Yes Group ID of this item. Optional. If missing, the 'group' attribute will be used as ID.
markerDisplayedbooleanElType No Yes Determines visibility of this item's marker.
renderedbooleanElType No Yes Determines if this data item should be processed and rendered.
seriesstringElType No Yes Series category of this item (if set).
seriesIdstringElType No Yes Series ID of this item. Optional. If missing, the 'series' attribute will be used as ID.
markerShapestringElType No Yes Shape of this item's marker. Does not apply to bars in a bar chart.
markerSizefloatElType No Yes Size of this item's marker. Does not apply to bars in a bar chart. In a bubble chart, the proportional size of data item's marker is determined by the z attribute value.
shortDescstringElType No Yes Custom description text to be displayed in tooltip.
valuefloatElType No Yes Value of this item.
xfloatElType No Yes X value of this item.
yfloatElType No Yes Y value of this item.
zfloatElType No Yes Z value of this item. Applies only to bubble chart where it determines the proportional size of the data item
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:attributeGroups> 0unbounded
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 01
<amx:closePopupBehavior> 01


Tag name: <dvtm:comboChart>

A DVT Mobile AMX combination chart. A combination chart is one in which data is represented as combination of bar or line markers.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
animationIndicatorsanimationIndicatorsElType No Yes Type of data change animation indicators. Valid values are: all (default), none.
animationDownColorcolorElType No Yes Color used to indicate a decreasing value.
animationUpColorcolorElType No Yes Color used to indicate an increasing value.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
dataCursordataCursorElType No Yes Specifies the data cursor visibility. Valid values are: auto (default), off, on. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting turns the data cursor display on for area and line charts on touch displays. Otherwise, the default is 'off'.
dataCursorBehaviordataCursorBehaviorElType No Yes Specifies the data cursor behavior. Valid values are: auto (default), smooth, snap. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting enables the smooth behavior for area and line charts and snap behavior for other chart types.
stackstackingElType No Yes Specifies whether the chart should be stacked. Applicable to area, bar, horizontalBar, combo and line charts only. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 12
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:y2Axis> 01
<dvtm:yFormat> 01
<dvtm:y2Format> 01


Tag name: <dvtm:dialGauge>

Dial gauge is used to measure small linear distances. Its name is based on the fact that the measurement results are displayed by means of a dial.

Attributes

NameTypeRequired?Supports EL?Description
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeDialGaugeElType No Yes Animation effect when the data changes. Valid values are: none (default), auto.
animationOnDisplayanimationOnDisplayDialGaugeElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade.
backgrounddialGaugeBackgroundElType No Yes A name of the background specification for the gauge. Valid values are: circleAntique (default), circleDark, circleLight, rectangleAntique, rectangleDark, rectangleLight, domeAntique, domeDark, domeLight.
indicatordialGaugeIndicatorElType No Yes A name of the indicator specification for the gauge. Valid values are: needleAntique (default), needleDark, needleLight.
readOnlybooleanElType No Yes Whether the user can drag on the gauge to change the value.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
minValuefloatElType No Yes The lowest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
maxValuefloatElType No Yes The greatest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
labelDisplaylabelDisplayElType No Yes Label display. Valid values are: off (default), on.
valuestringElType No Yes The value of the component.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:gaugeLabelFormat> 01
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <dvtm:gaugeLabelFormat>

Gauge label value formatter.

Attributes

NameTypeRequired?Supports EL?Description
scalinglabelScalingElType No Yes Gauge label value scaling. Valid values are: auto (default), none, thousand, million, billion, trillion, quadrillion.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:geographicMap>

A DVT Mobile AMX georgraphic map.

Attributes

NameTypeRequired?Supports EL?Description
mapTypestringElType No Yes The map type for the geographic map. Map provider specific. Google Maps API offers HYBRID, ROADMAP, SATELLITE, and TERRAIN.
centerXfloatElType No Yes The x coordinate (longitude) for specifying the center of the map.
centerYfloatElType No Yes The y coordinate (latitude) for specifying the center of the map.
zoomLevelintegerElType No Yes The initial zoom level of the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21 (down to individual buildings) are possible within the default roadmap maps view for Google Maps. For Oracle Maps, the zoom levels are defined as part of the base map. The zoom levels are ordered from level 0 to level n-1, where level 0 is the most zoomed out level and level n-1 is the most zoomed in level.
initialZoominginitialZoomingElType No Yes Zooms map to fit data on initial render. Valid values are: auto (default), none.
animationOnDisplayanimationOnDisplayGeoMapElType No Yes Animation effect when the geographic map is initially displayed. Valid values are: none (default), auto. Only supported by Google Maps.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:pointDataLayer> 0unbounded


Tag name: <dvtm:horizontalBarChart>

A DVT Mobile AMX horizontal bar chart. A bar chart is one in which data is represented as series of horizontal bars.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
animationIndicatorsanimationIndicatorsElType No Yes Type of data change animation indicators. Valid values are: all (default), none.
animationDownColorcolorElType No Yes Color used to indicate a decreasing value.
animationUpColorcolorElType No Yes Color used to indicate an increasing value.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
dataCursordataCursorElType No Yes Specifies the data cursor visibility. Valid values are: auto (default), off, on. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting turns the data cursor display on for area and line charts on touch displays. Otherwise, the default is 'off'.
dataCursorBehaviordataCursorBehaviorElType No Yes Specifies the data cursor behavior. Valid values are: auto (default), smooth, snap. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting enables the smooth behavior for area and line charts and snap behavior for other chart types.
stackstackingElType No Yes Specifies whether the chart should be stacked. Applicable to area, bar, horizontalBar, combo and line charts only. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 12
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:y2Axis> 01
<dvtm:yFormat> 01
<dvtm:y2Format> 01


Tag name: <dvtm:ledGauge>

A DVT Mobile AMX LED gauge. LED gauge indicates its value mainly by its color. It changes its color to match the threshold range into which the metric value falls.

Attributes

NameTypeRequired?Supports EL?Description
rotationledGaugeRotationEnumeration No No The rotation angle for the gauge. Useful for changing the direction of triangle or arrow gauges. Valid values are: 0 (default), 90, 180, 270.
typeledGaugeTypeEnumeration No No The type of the led gauge. Valid values are: arrow, circle (default), diamond, rectangle, triangle.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
borderColorcolorElType No Yes Gauge border color.
colorcolorElType No Yes Gauge fill color.
visualEffectsvisualEffectsEnumeration No No Gauge visual effects. Valid values are: auto (default), none.
minValuefloatElType No Yes The lowest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
maxValuefloatElType No Yes The greatest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
labelDisplaylabelDisplayElType No Yes Label display. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:threshold> 0unbounded
<dvtm:gaugeLabelFormat> 01
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <dvtm:legend>

The chart legend.

Attributes

NameTypeRequired?Supports EL?Description
positionlegendPositionElType No Yes Position in the chart. Valid values are: auto (default), start, end, top, bottom, none.
referenceObjectTitlestringElType No Yes Text to be displayed as the title of the reference objects section (if specified).
scrollinglegendScrollingElType No Yes Determines if the legend should support scrolling. Valid values are: off (default), on, asNeeded.
titleHalignhAlignElType No Yes Legend title horizontal alignment. Valid values are: start (default), end, center.
titlestringElType No Yes Text to be displayed as the legend title.
sectionTitleHalignhAlignElType No Yes Legend section title horizontal alignment. Valid values are: start (default), end, center.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:legendSection> 0unbounded


Tag name: <dvtm:legendSection>

The section of a multi-section legend.

Attributes

NameTypeRequired?Supports EL?Description
sourcestring No No ID of the attributeGroups to be used for populating this legend section.
titlestringElType No Yes Text to be displayed as the legend section title.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.

Child Elements

None.


Tag name: <dvtm:lineChart>

A DVT Mobile AMX line chart. A line chart is one in which data is represented as lines.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
animationIndicatorsanimationIndicatorsElType No Yes Type of data change animation indicators. Valid values are: all (default), none.
animationDownColorcolorElType No Yes Color used to indicate a decreasing value.
animationUpColorcolorElType No Yes Color used to indicate an increasing value.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
dataCursordataCursorElType No Yes Specifies the data cursor visibility. Valid values are: auto (default), off, on. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting turns the data cursor display on for area and line charts on touch displays. Otherwise, the default is 'off'.
dataCursorBehaviordataCursorBehaviorElType No Yes Specifies the data cursor behavior. Valid values are: auto (default), smooth, snap. Applicable to area, bar, horizontalBar, combo and line charts only. The 'auto' setting enables the smooth behavior for area and line charts and snap behavior for other chart types.
stackstackingElType No Yes Specifies whether the chart should be stacked. Applicable to area, bar, horizontalBar, combo and line charts only. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 12
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:y2Axis> 01
<dvtm:yFormat> 01
<dvtm:y2Format> 01


Tag name: <dvtm:majorTick>

Major tick.

Attributes

NameTypeRequired?Supports EL?Description
lineColorcolorElType No Yes Major tick color.
lineWidthintegerElType No Yes Major tick width.
renderedbooleanElType No Yes Determines if the tick should be rendered. True by default for the major tick.

Child Elements

None.


Tag name: <dvtm:marker>

A marker is used to stamp out built-in or custom shapes associated with data points on a map component. Markers can be customized with different stylistic attributes such as colors and patterns based on their underlying data. Geographic map marker only supports action, shortDesc, and source attributes.

Attributes

NameTypeRequired?Supports EL?Description
gradientEffectgradientEffectElType No Yes The gradient effect for this marker. Valid values are: auto (default), "none".
labelPositionlabelPositionElType No Yes Position of the label relative to the marker. Valid values are: center (default), top, bottom.
scaleXfloatElType No Yes Horizontal scale factor for this marker determining how much to scale from default size.
scaleYfloatElType No Yes Vertical scale factor for this marker determining how much to scale from default size.
shapemarkerShapeElType No Yes Shape of the marker. Valid values are: circle (default), square, plus, diamond, triangleUp, triangleDown, human.
sourcestringElType No Yes The URI specifying the location of the image resource. The shape attribute is ignored if source is specified.
sourceSelectedstringElType No Yes The optional URI specifying the location of the selected image resource. If not defined, the source image will be used.
sourceHoverstringElType No Yes The optional URI specifying the location of the image resource on hover. If not defined, the source image will be used.
sourceHoverSelectedstringElType No Yes The optional URI specifying the location of the selected image resource on hover. If not defined, the sourceSelected image will be used. If sourceSelected is not defined, then source image will be used.
valuestringElType No Yes When labelDisplay is on, this value will be used as the text label for the marker.
renderedbooleanElType No Yes Determines if the marker should be rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
fillColorcolorElType No Yes Data item fill color.
opacityfloatElType No Yes Opacity of the fill. Valid values are from 0.0-1.0 where 0.0 is transparent and 1.0 is opaque.
labelStylestringElType No Yes Font style for labels associated with this data item. Valid values are font-related CSS attributes.
labelDisplaylabelDisplayElType No Yes Label display. Valid values are: off (default), on.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:attributeGroups> 0unbounded
<amx:convertNumber> 01
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 01
<amx:closePopupBehavior> 01


Tag name: <dvtm:minorTick>

Minor tick.

Attributes

NameTypeRequired?Supports EL?Description
lineColorcolorElType No Yes Minor tick color.
lineWidthintegerElType No Yes Minor tick width.
renderedbooleanElType No Yes Determines if the tick should be rendered. False by default for the minor tick.

Child Elements

None.


Tag name: <dvtm:pieChart>

A DVT Mobile AMX pie chart. In a pie chart one group of data is represented as sections of a circle, making the circle look like a sliced pie. Can be used to represent percentages of a whole.

Attributes

NameTypeRequired?Supports EL?Description
threeDEffectthreeDEffectElType No Yes Specifies if the chart should be displayed with a 3D effect. Valid values are: off (default), on.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 11
<dvtm:legend> 01
<dvtm:sliceLabel> 01
<dvtm:pieValueFormat> 01


Tag name: <dvtm:pieDataItem>

Pie data item.

Attributes

NameTypeRequired?Supports EL?Description
borderColorcolorElType No Yes Slice border color.
colorcolorElType No Yes Slice fill color.
explodeintegerElType No Yes Slice explode offset in percent (0..100%).
labelstringElType No Yes Slice label.
renderedbooleanElType No Yes Determines if this data item should be processed and rendered.
sliceIdstringElType No Yes Slice ID of this item. Optional. If missing, the 'label' attribute will be used as ID.
valuefloatElType No Yes Value represented by this slice.
actionstringElType No Yes Defines a reference to an action method sent by the command component, or the static outcome of an action.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:setPropertyListener> 0unbounded
<amx:showPopupBehavior> 01
<amx:closePopupBehavior> 01


Tag name: <dvtm:pieValueFormat>

Pie Value Format.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:pointDataLayer>

The pointDataLayer allows developers to display data associated with a point on the map using a marker. The point can be a specified by city id for a built-in basemap or x/y coordinates which coorespond to latitude/longitude for built-in basemaps.

Attributes

NameTypeRequired?Supports EL?Description
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnPointDataChangeElType No Yes Animation effect when the data changes. Valid values are: none (default), alphaFade.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
varstring No No The name of the variable to be used for data item stamping.
renderedbooleanElType No Yes Determines if the point data layer should be rendered.
selectedRowKeysrowKeyListElType No Yes The selection state of the data layer.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:pointLocation> 01


Tag name: <dvtm:pointLocation>

Specifies the columns in the data layer's model that determine the location of the data points. For thematic map, these locations can be names that join with named points or latitude/longitude for built-in basemaps, x/y coordinates for custom basemaps. For geographic map, they can be x/y coordinates or an address.

Attributes

NameTypeRequired?Supports EL?Description
typepointTypeElType No Yes The type of the piont data being used. Valid values are: pointName (thematicMap pnly), pointXY, address (geographicMap only)
pointNamestringElType No Yes Column in the data model that determines the location of the point data. The locations are ids of the named points from the basemap point layer for which the data is being displayed. Used only when the pointLocation type="pointName". Not supported by geographicMap.

For the "usa" basemap, city ids are the two letter state abbreviation the city is located in, followed by an underscore, and then the name of the city, all in capital letters with underscores replacing characters that are not letters (e.g., the id for Boston, Massachusetts is "MA_BOSTON" and the id for San Antonio, Texas is "TX_SAN_ANTONIO")

For all other basemaps, the city ids are determined by taking the three-letter country code, followed by an underscore, and then the name of the city, all in capital letters with underscores replacing characters that are not letters (e.g., the id for Toronto, Canada is "CAN_TORONTO" and the id for Los Angeles, United States is "USA_LOS_ANGELES")

Links to complete lists of the location ids for all basemaps are listed below:

pointXfloatElType No Yes The x coordinate (longitude) of the point data. Used only when the pointLocation type="pointXY".
pointYfloatElType No Yes The y coordinate (latitude) of the point data. Used only when the pointLocation type="pointXY".
addressstringElType No Yes The address of the point location which will be geocoded. This only applies to geographicMap.
renderedbooleanElType No Yes Determines if the point location should be rendered.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:marker> 01


Tag name: <dvtm:referenceObject>

Reference object for an axis.

Attributes

NameTypeRequired?Supports EL?Description
colorcolorElType No Yes Reference object color.
displayInLegenddisplayInLegendElType No Yes Determines whether this reference object should be displayed in legend.
highValuefloatElType No Yes Reference high value.
lineValuefloatElType No Yes Reference value.
lowValuefloatElType No Yes Reference low value.
lineStylelineStyleElType No Yes Reference line style. Valid values are: solid (default), dashed, dotted.
lineWidthintegerElType No Yes Reference line width.
textstringElType No Yes Tooltip and legend text for this reference object.
shortDescstringElType No Yes Custom description for this reference object. To be displayed in tooltip.
typereferenceObjectTypeEnumeration No No Reference object type. Valid values are: line (default), area.

Child Elements

None.


Tag name: <dvtm:scatterChart>

A DVT Mobile AMX scatter chart. A scatter chart represents data by the location of data markers. Scatter charts are useful for displaying general relationships among a number of data points.

Attributes

NameTypeRequired?Supports EL?Description
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
footnotestringElType No Yes Chart footnote text.
footnoteHalignhAlignElType No Yes Chart footnote horizontal alignment. Valid values are: start (default), end, center.
hideAndShowBehaviorhideAndShowBehaviorElType No Yes Specifies the hide/show behavior when clicking on legend markers/labels. Valid values are: none (default), withRescale, withoutRescale.
rolloverBehaviorrolloverBehaviorElType No Yes Specifies the rollover behavior when hovering over the chart markers/labels. Valid values are: none (default), dim.
selectionListenerelExpression No YesDefines a method reference to a selection listener.
subtitlestringElType No Yes Chart subtitle text.
titlestringElType No Yes Chart title text.
titleHalignhAlignElType No Yes Chart title horizontal alignment. Valid values are: start (default), end, center.
timeAxisTypetimeAxisTypeEnumeration No No Time axis type. Valid values are: disabled (default), enabled, mixedFrequency.
varstring No No The name of the variable to be used for data item stamping.
dataSelectiondataSelectionElType No Yes Data selection mode. Valid values are: none (default), single, multiple.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 11
<dvtm:legend> 01
<dvtm:xAxis> 01
<dvtm:yAxis> 01
<dvtm:xFormat> 01
<dvtm:yFormat> 01


Tag name: <dvtm:seriesStyle>

Series style definition.

Attributes

NameTypeRequired?Supports EL?Description
assignedToY2booleanElType No Yes Determines if the series should be assigned to the Y2 axis.
borderColorcolorElType No Yes Series border color.
colorcolorElType No Yes The color of this series (e.g. color of the line in a line chart, or color of the area in an area chart).
lineWidthintegerElType No Yes Series line width.
lineStylelineStyleElType No Yes Series line style. Valid values are: solid (default), dashed, dotted.
markerColorcolorElType No Yes A common color for data item markers in this series. May be overriden by the data item's markerColor attribute value.
markerDisplayedbooleanElType No Yes Should markers be displayed for the series.
markerShapestringElType No Yes A common shape of markers in the series. May be overrided by the data item's markerShape atribute value.
markerSizeintegerElType No Yes Size of markers for the series.
renderedbooleanElType No Yes Should this series be rendered.
seriesstringElType No Yes Series name.
seriesIdstringElType No Yes Series ID. Optional. If missing, the 'series' name is used as ID.
typeseriesStyleTypeEnumeration No No Series style type for combo chart. Valid values are: bar, line.

Child Elements

None.


Tag name: <dvtm:sliceLabel>

Slice label for pie slice.

Attributes

NameTypeRequired?Supports EL?Description
autoPrecisionautoPrecisionEnumeration No No Determines if auto precision should be enabled for slice label. Valid values are: on (default), off.
positionsliceLabelPositionEnumeration No No Slice label position. Valid values are: none, inside, outside (default).
renderedbooleanElType No Yes Determines if the slice label should be rendered.
scalinglabelScalingElType No Yes Slice label scaling. Valid values are: auto (default), none, thousand, million, billion, trillion, quadrillion.
textTypetextTypeEnumeration No No Slice label text type. Valid values are: percent (default), text, textAndPercent, value.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:sparkChart>

A DVT Mobile AMX spark chart. Spark charts are simple, condensed charts that display trends or variations, often in the column of a table. Spark charts are often displayed in a dashboard to provide additional context to a data-dense display.

Attributes

NameTypeRequired?Supports EL?Description
colorcolorElType No Yes The color of the bars, line, or area.
firstColorcolorElType No Yes The color of the first data item.
lastColorcolorElType No Yes The color of the last data item.
highColorcolorElType No Yes The color of the data item with the greatest value.
lowColorcolorElType No Yes The color of the data item with the lowest value.
typesparkChartTypeEnumeration No No The type of the spark chart. Valid values are: area, bar, floatingBar, line (default).
varstring No No The name of the variable to be used for data item stamping.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
valuestringElType No Yes The value of the component.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:facet> 11
<dvtm:referenceObject> 0unbounded


Tag name: <dvtm:sparkDataItem>

Spark data item.

Attributes

NameTypeRequired?Supports EL?Description
colorcolorElType No Yes Spark item fill color. Specifies the color of a bar or the data point. For line and area chart types, markerDisplayed must be enabled to make the data items visible.
dateintegerElType No Yes Spark item date in ms since epoch.
floatValuefloatElType No Yes Spark item float value.
markerDisplayedbooleanElType No Yes Should markers be displayed for the spark item.
renderedbooleanElType No Yes Should this spark item be rendered.
valuefloatElType No Yes Value represented by this spark item.

Child Elements

None.


Tag name: <dvtm:statusMeterGauge>

A DVT Mobile AMX status meter gauge. Status meter gauge indicates its value by its color and area. It changes its color and area to match the threshold range into which the metric value falls.

Attributes

NameTypeRequired?Supports EL?Description
readOnlybooleanElType No Yes Whether the user can drag on the gauge to change the value.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDataChangeanimationOnDataChangeChartElType No Yes Animation effect when the data changes. Valid values are: none (default), auto, alphaFade, slideToLeft, slideToRight.
animationOnDisplayanimationOnDisplayChartElType No Yes Animation effect when the chart is initially displayed. Valid values are: none (default), auto, alphaFade, zoom.
borderColorcolorElType No Yes Gauge border color.
colorcolorElType No Yes Gauge fill color.
visualEffectsvisualEffectsEnumeration No No Gauge visual effects. Valid values are: auto (default), none.
minValuefloatElType No Yes The lowest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
maxValuefloatElType No Yes The greatest value on the gauge scale. In case of dial gauge this value is used only for the calculation of the indicator angle, and is not displayed on the gauge.
labelDisplaylabelDisplayElType No Yes Label display. Valid values are: off (default), on.
emptyTextstringElType No Yes Text displayed when there is no data or the data cannot be displayed.
shortDescstringElType No Yes The short description of the component. The short description property value should be set to provide basic accessibility.
valuestringElType No Yes The value of the component.
valueChangeListenerelExpression No YesDefines a method reference to a value change listener. The method represented by this EL expression will be invoked when onChange occurs and after the model is updated.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:threshold> 0unbounded
<dvtm:gaugeLabelFormat> 01
<amx:showPopupBehavior> 0unbounded
<amx:closePopupBehavior> 0unbounded
<amx:validationBehavior> 0unbounded


Tag name: <dvtm:thematicMap>

A DVT Mobile thematic map which is used for displaying spatial trends or patterns in data.

Attributes

NameTypeRequired?Supports EL?Description
animationDurationintegerElType No Yes Animation duration in milliseconds.
animationOnDisplayanimationOnDisplayTMapElType No Yes Animation effect when the thematic map is initially displayed. Valid values are: none (default), alphaFade, zoom.
animationOnMapChangeanimationOnLayerMapChangeElType No Yes Animation effect when the basemap changes. Valid values are: none (default), alphaFade, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, zoom.
basemapbasemapElType No Yes The basemp shown by the thematic map. Valid values are: usa, world, africa, asia, australia, europe, northAmerica, southAmerica, apac, emea, latinAmerica, usaAndCanada.
tooltipDisplaytooltipDisplayElType No Yes The tooltip display behavior of the thematic map. Valid values are: auto (default), none, shortDescOnly.
zoomingzoomingElType No Yes Determines whether component zooming is allowed. Valid values are: auto, none (default).
panningpanningElType No Yes Determines whether component panning is allowed. Valid values are: auto, none (default).
initialZoominginitialZoomingElType No Yes Zooms map to fit data on initial render. Valid values are: auto, none (default).
sourcestringElType No Yes The URI specifying the location of the custom basemap metadata file. If set, the basemap attribute will not be used to search for a built-in map.
idcomponentId No No Specifies the identifier for the component. The identifier must follow the following rules: Must not be zero length; First character must be an ASCII letter; Subsequent characters must be ASCII letter or digit or underscore or dash.
inlineStylestringElType No Yes The CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component.
styleClassstringElType No Yes A CSS style class to use for this component. The style class can be defined in your AMX page or in a skinning CSS file, for example, or you can use one of our public style classes.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:areaLayer> 0unbounded
<dvtm:pointDataLayer> 0unbounded
<dvtm:legend> 01


Tag name: <dvtm:threshold>

Gauge threshold.

Attributes

NameTypeRequired?Supports EL?Description
borderColorcolorElType No Yes Threshold border color. Overrides the default gauge border color, if specified.
colorcolorElType No Yes Threshold color. Overrides the default gauge color, if specified.
textstringElType No Yes Threshold text.
maxValuefloatElType No Yes The maximum value of this threshold's range. If not specified, defaults to the maximum value of the gauge.

Child Elements

None.


Tag name: <dvtm:tickLabel>

Tick label for the axis.

Attributes

NameTypeRequired?Supports EL?Description
autoPrecisionautoPrecisionEnumeration No No Determines if auto precision should be enabled for tick label. Valid values are: on (default), off.
renderedbooleanElType No Yes Determines if the tick label should be rendered.
scalinglabelScalingElType No Yes Tick label scaling. Valid values are: auto (default), none, thousand, million, billion, trillion, quadrillion.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01
<amx:convertDateTime> 01


Tag name: <dvtm:xAxis>

X axis.

Attributes

NameTypeRequired?Supports EL?Description
titlestringElType No Yes Axis title.
timeRangeModetimeRangeModeEnumeration No No Time range mode. Valid values are: off (default), explicit, relativeFirst, relativeLast.
axisMinValuefloatElType No Yes Minimum axis value.
axisMaxValuefloatElType No Yes Maximum axis value.
majorIncrementfloatElType No Yes Increment between major ticks.
minorIncrementfloatElType No Yes Increment between minor ticks.
scaledFromBaselinescaledFromBaselineElType No Yes Specifies whether the axis is scaled to include the baseline value of zero. Valid values are: off, on (default).

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:referenceObject> 0unbounded
<dvtm:tickLabel> 01
<dvtm:axisLine> 01
<dvtm:majorTick> 01
<dvtm:minorTick> 01


Tag name: <dvtm:xFormat>

X Format.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:y2Axis>

Y2 axis.

Attributes

NameTypeRequired?Supports EL?Description
alignTickMarksbooleanElType No Yes Determines if y2 and y1 tick marks should be aligned. Valid values are: true (default), false.
titlestringElType No Yes Axis title.
axisMinValuefloatElType No Yes Minimum axis value.
axisMaxValuefloatElType No Yes Maximum axis value.
majorIncrementfloatElType No Yes Increment between major ticks.
minorIncrementfloatElType No Yes Increment between minor ticks.
scaledFromBaselinescaledFromBaselineElType No Yes Specifies whether the axis is scaled to include the baseline value of zero. Valid values are: off, on (default).

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:referenceObject> 0unbounded
<dvtm:tickLabel> 01
<dvtm:axisLine> 01
<dvtm:majorTick> 01
<dvtm:minorTick> 01


Tag name: <dvtm:y2Format>

Y2 Format.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:yAxis>

Y axis.

Attributes

NameTypeRequired?Supports EL?Description
titlestringElType No Yes Axis title.
axisMinValuefloatElType No Yes Minimum axis value.
axisMaxValuefloatElType No Yes Maximum axis value.
majorIncrementfloatElType No Yes Increment between major ticks.
minorIncrementfloatElType No Yes Increment between minor ticks.
scaledFromBaselinescaledFromBaselineElType No Yes Specifies whether the axis is scaled to include the baseline value of zero. Valid values are: off, on (default).

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<dvtm:referenceObject> 0unbounded
<dvtm:tickLabel> 01
<dvtm:axisLine> 01
<dvtm:majorTick> 01
<dvtm:minorTick> 01


Tag name: <dvtm:yFormat>

Y Format.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <dvtm:zFormat>

Z Format.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<amx:convertNumber> 01


Tag name: <skin:adfmf-skins>

The root element defined in the adfmf-skins document.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<skin:skin> 0unbounded
<skin:skin-addition> 0unbounded


Tag name: <skin:default>

true if this skin is the default skin for the specified skin family. The default skin will be picked if the adfmf-config's skin-version is not set or it is set to "default".

Attributes

None.

Child Elements

None.


Tag name: <skin:extends>

The id of the parent skin which this custom look and feel extends.

Attributes

None.

Child Elements

None.


Tag name: <skin:family>

A name which identifies the skin family to which this skin implementation belongs.

Attributes

None.

Child Elements

None.


Tag name: <skin:id>

A string identifier which uniquely identifies this custom skin implementation.

Attributes

None.

Child Elements

None.


Tag name: <skin:name>

Defines a skin version name.

Attributes

None.

Child Elements

None.


Tag name: <skin:skin>

Defines a skin.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<skin:id> 11
<skin:family> 11
<skin:version> 01
<skin:extends> 01
<skin:style-sheet-name> 01


Tag name: <skin:skin-addition>

Defines a skin addition. A skin addition which is created by custom component developers to add skinning information for the custom component.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<skin:skin-id> 11
<skin:style-sheet-name> 01


Tag name: <skin:skin-id>

A string identifier which uniquely identifies the skin you are pushing your styles into.

Attributes

None.

Child Elements

None.


Tag name: <skin:style-sheet-name>

The name of the style sheet which defines the styles for this skin addition.

Attributes

None.

Child Elements

None.


Tag name: <skin:version>

The version of the skin, if any.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<skin:name> 11
<skin:default> 01


Tag name: <config:adfmf-config>

The adfmf-config element is the root element of all adfmf-config.xml files.

Attributes

None.

Child Elements

Child ElementMinimum OccurrencesMaximum Occurrences
<config:skin-family> 01
<config:skin-version> 01


Tag name: <config:skin-family>

The skin-family element is used to pick a skin during render. You can optionally add the skin-version to pick a particular version of a skin with the same skin-family.

Attributes

None.

Child Elements

None.


Tag name: <config:skin-version>

The skin-version element is used to pick a skin during render. A skin is picked by matching the skin-id (required), and if specified here, the skin-version.

Attributes

None.

Child Elements

None.