Mobile Components


Standard Syntax:
     <%@ taglib prefix="mobi" uri="http://www.icesoft.com/icefaces/mobile/component" %>

XML Syntax:
     <anyxmlelement xmlns:mobi="http://www.icesoft.com/icefaces/mobile/component" />

No Description

Tag Library Information
Display NameMobile Components
Version1.3.1
Short Namemobi
URIhttp://www.icesoft.com/icefaces/mobile/component
 

Tag Summary
accordionFormProxyaccordionFormProxy allows accordions to nest forms and still maintain server-side current pane state
accordionThis mobility component allows panels to be placed within accordion controls in a stacked manner. Only a single pane may be active at a time which is the selectedId which must be bound to a value in a backing bean as the accordion component makes use of the ContentPaneTagHandler class. Default for the content pane height will be autoHeight of true, in which case the contentPanes height will all be set to the largest known height of all the contentPanes. Since some of the contentPane children may not be fully rendered yet, the process to find the maximum height of contentPanes may be ongoing until all the panes have been opened. If autoHeight is set to false, then a fixedHeight may be used.
viewSelectorView select allows a developer to specify content for a smallview or a large view. The component will render the respective content depending on which view was detected.
Facets
small
large

onlineStatusRenders a header/body/footer layout that is defined using the facet tag. The facets for header and footer are optional.
inputTextThe inputText component renders an input element with HTML5 and Ajax support. This component supports various input types, when supported on the client platform, such as "date", "number" and "email".
Client Events
NameDescriptionSupported classes for argument
blurFired when the inputText component has lost focus.javax.faces.event.AjaxBehaviorEvent
changeFired when the inputText component detects value is changed.javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
menuButtonGroupThis component renders an optgroup element to order a collection of menuButtonItems as children.This component cannot be selected but may be disabled which disabled all its children from being selected. Parent must be a MenuButton component.
menuButtonItemThis component fires an actionListener from a menu button. It has the same functionality of a regular JSF UICommand. It may have a panelConfirmation and/or a submitNotification component attribute specified to allow the developer to confirm a submit and to disable the page showingthe disable while the submit is happening.
Client Events
NameDescriptionSupported classes for argument
clickFired when commandButton is clickedjavax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
menuButtonThis component renders a select menu button with a collection or list of menuButtonItems as children. Upon selection of a menuButtonItem, an actionListener will be queued. Children mayonly be icemobile component type of menuButtonItem, and a collection may be specified by the value attribute with the var attribute as per UISeries implementation. Otherwise, several menuButtonItem children can be designated as children of this component.
viewManagerNo Description
viewNo Description
contentStackMenucontentStackMenu renders a menu represented by a collection of contentMenuItems and is meant to be used with a contentStack component for layout and navigation through the designated contentStack. When in a small view, the contentStackMenu is meant to be within one of the contentPane children of the contentStack. When in a large view with splitPane, it is meant to be a sibling to the contentStack and not within a contentPane itself. In this way the component knows how to behave regarding transisitons. Currently defined transitions are sliding panes within small view only. Related components for navigation through contentStack are contentMenuItem, which is only legitimate child component of this one, and contentNavBar, which also takes contentMenuItem as children. This component may take a list of contentMenuItems as children, or a Collection can be value bound to the value attribute with a var attribute to a single contentMenuItem child to be iterated over.
graphicImageRender markup for <img> with support for byte[] for images from database.
dateSpinnerDateSpinner is an input component used for choosing a date.
Client Events
NameDescriptionSupported classes for argument
changeFired when a change is detected in date selection.javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
panelConfirmationThis mobility component renders a confirmation panel to be used with any mobi commandButton or menuButton component. See commandButton and menuButton docs for the correct attribute to bind this component to the button components. This component was modelled after 1.8 panelConfirmation and disabled feature wasnot part of the functionality of that component so not carried over to this one.
gMapMarkerNo Description
gMapLayerA version 3.0 API google map interface.
gMapThis component renders a Google Maps v3 control.
gMapOverlayA version 3.0 API google map interface.
contentMenuItemThis component fires an actionListener from a menu item. The value can be a url, or, more typically, an id to a panel in the contentStack that is controlled by its parent, which must be either a ContentStackMenu or a ContentNavBar. If it's a child of the ContentStackMenu, then it's rendered as a list item. If a child of the ContentNavBar, it is rendered as a button on a tool bar. If the value attribute is null, then it becomes a menu heading and no selection of the contentStack is done. A non-null value must represent the id of the contentPane in the contentStack to make current. If the contentStackMenu has attribute accordion equal to true, then a null value attribute will render an accordion handle with accordion functionality. The following contentMenuItems with non-null values will be children of that accordion pane, to the next, etc. Beta feature
panelPopupThis mobility component renders a confirmation panel to be used with any mobi commandButton or menuButton ifclientSide is false. If clientSide is true, then use of the clientSide api is available. See wiki docs for api for clientSide "true" or sample apps.A facet with name of label is available which show styled facet heading while allowing developers to add images or other markup rather than simple text as does the headerText attribute. If a label facet is present, the headerText attribute is ignored.
timeSpinnerTimeSpinner is an input component that provides a time input.
Client Events
NameDescriptionSupported classes for argument
changeFires when a change is detected in the time spinner.javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
outputListoutputList defines a grouping of unordered list items. The child component of this component must be outputListItem components.
outputListItemoutputListItem is used within an outputList tag to group unordered list items.
outputListItemsoutputListItems is used within an outputList tag to group lists of items.
geolocationgeolocation captures a geolocation object of longitude and latitude, heading, speed and altitude via html5 navigator API.
submitNotificationsubmitNoftification renders a panel, to be used with any mobi commandButton, which blocks any other submission until a response is recieved and the update completes.
cameraRenders a button to access the camera on supported clients, and allows uploading and storing an image from the camera or image gallery. The component will fallback to a input file type on unsupported browsers.
ajaxRegister an AjaxBehavior instance on one UIComponent implementing the ClientBehaviorHolder interface. This tag may be nested within a single component to enable Ajax for that single component.
fieldsetRowfieldsetRow is used within a fieldsetGroup tag to group unordered items.
fieldsetGroupfieldSetGroup organizes a grouping of unordered list items. The immediate children must be fieldsetRow components.
largeViewLargeView will include and render the child components when the client is a desktop or tablet view.
contentStackFormProxycontentStackFormProxy allows contentPanes to nest forms and still maintain server-side current pane state
contentStackcontentStack manages child contentPanes, controlling which child is visible.
smallViewSmallView will include and render the child components when the client is a handheld.
videoPlayervideoPlayer renders a video player to play back videos. The component can be bound to a variety of source types.
thumbnailthumbnail provides a thumbnail image to a camera or camcorder component.
splitPanesplitPane renders a div with two children that can be defined for page layout. It can be scrollable, have columnDivider at certain location. Requires a left and right facet for two, side by side, panels. Eventually will also be resizable.
Facets
left
right

flipswitchThe flipswitch provides a control that toggles between on and off states.
Client Events
NameDescriptionSupported classes for argument
activateFired when the the flip switch has realized an onclick eventjavax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
contentNavBarRenders a navigation tool bar for the contentPane component. Allowable children are contentMenuItems and HTML content. The contentNavBar must used inside of a contentPane.
pagePanelRenders a header/body/footer layout that is defined using the facet tag. The facets for header and footer are optional.
Facets
header
body
footer

carouselRenders a scrollable, touch-enabled, horizontal list.
Client Events
NameDescriptionSupported classes for argument
changeFired when the carousel position is changed. javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
dataViewColumnsThe DataViewColumns component defines the table region of the DataView component either by its DataViewColumn child components or by attaching an implementationof DataViewColumnsModel to the 'value' attribute of this component.
dataViewThe DataView component renders a table region for iterative output using columns defined with the required DataViewColumns component child, and a detail region for extensive viewing (and editing) of the row objects of the table model. The detail regionis defined with the DataViewDetails child component and it's contents are displayed when a row of table region is activated, typically by a row tap.
dataViewColumnDataViewColumns defines a column in the table region of the DataView component.
dataViewDetailsThe child components of this component define the region to be displayed when a row object of DataView table region is activated. When DataView 'activationMode' is set to 'server' the child components of this region may be arbitrary JSF components. When 'activationMode' is set to 'client' the child components of this region are prerendered and have their dynamic attributes cached on the client to allow instanteous activation. Client activation mode is restricted to particular components and only particular attributes of these components may be dynamic, the specifics are documented on our wiki.
googleAnalyticsThe googleAnalytics component will render the necessary script for using Google Analytics. The ga account and domain may be specified with the system properties org.icemobile.googleAnalyticsAccount and org.icemobile.googleAnalyticsDomain or the component attributes "account" and "domain". If the "account" attribute is set, this will override any system environment variable.
deviceStylesheetdeviceStylesheet component loads an outputStyleSheet in the head of a jsf view page based upon a detected device/desktop or a user-specified theme. If the JSF content parameter of Project Stage evaluates to "Production" the compressed css file is loaded into the head. The component has three modes in which it executes. 1.) no attributes - then component tries to detect a mobile device in from the user-agent. If a mobile device is discovered, then it will fall into three possible matches, iphone, ipad, android and blackberry. If the mobile device is not not know then ipad as default is loaded. Library is always assumed to be DEFAULT_LIBRARY. 2.) name attribute - component will default to using a library name of DEFAULT_LIBRARY (currently set to org.icefaces.component.skins. The name attribute specifies one of the possible device themes; iphone.css, android.css or bberry.css An Error will result if named resource could not be resolved. 3.) name and libraries attributes. - component will use the library and name specified by the user. Component is fully manual in this mode. Error will result if name and library can not generate a value resource.
tabSetThis mobility component allows contentPane's to be placed within tabset controls in a stacked manner. Only a single contentPane may be active at a time.
commandButtonRenders an HTML "input" element. The component can be styled for the supported mobile device platforms, as well as be used in a group of buttons.
Client Events
NameDescriptionSupported classes for argument
clickFired when commandButton is clicked. javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
commandButtonGroupThis component allows the grouping of commandButtons. The buttons can be grouped horizontally or vertically.
openResourceThis component provides a link to a resource that will be opened on a mobile device For desktop, this falls back to a simple hyperlink. For the short term it can be styled as a button or a link, whichever is easier. On compatible devices, this is a device command where the value of the link is passed to an "open" command.
audioPlayerThis component renders an HTML5 audio element. The component can be bound to a variety of source types. Playback options can be controlled. JSF Resource management options are also available.
contentPaneThis mobility component is a child of several different layout components such as contentStack, accordion or tabSet, or any other future mobility component which implements ContentPaneController. The facelet attribute determines whether the children of this component are constructed in the server side component tree. A special tag handler is utilised to assist with this task. The desired outcome of this feature is to allow developers to maintain as small a server-side component tree as possible for purposes of increased scalability.The facelet attribute defaults to false meaning that the children are constructed and present in server side component tree. If the client attribute is true, this means children of this component are not only constructed but area also always rendered on the client --best for static data
deviceResourceRender the necessary HTML head resources for a detected device, including the device-specific meta tags, the CSS themes, and javascript.
 


Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.