DashboardPane

compared with
Current by Arturo Zambrano
on May 22, 2018 19:32.


 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 1 changes. View first change.

 h2. Overview
 _Since 4.3_
  
  
 The {{ace:dashboardPane}} component defines one of the panes of an {{ace:dashboard}}. It can include a header and a footer and an arbitrary number of child components and markup. It can also be resized, moved and closed.
  
 {tip}See the ICEfaces Showcase [Live Demo|http://icefaces-showcase.icesoft.org/showcase.jsf?grp=ace:dashboardPane] of this component, complete with source code.{tip}
  
 h2. Getting Started
  
  
 An {{ace:dashboardPane}} component can be defined as follows.
 {panel}
 {code:xml|borderStyle=dashed}
  <h:form id="form">
  <ace:dashboard id="dashboard">
  <ace:dashboardPane headerText="Header" row="1" column="1" sizeY="2" sizeX="3" closable="true">
  <h:outputText value="Pane content." />
  </ace:dashboardPane>
  </ace:dashboard>
  </h:form>
 {code}
 {panel}
  
  
 h2. Attributes
  
 {tip:title=TagLib Documentation}This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available [here|http://www.icefaces.org/docs/v4_latest/ace/tld/ace/dashboardPane.html].{tip}
  
 {panel}
 *maxColumns* The maximum number of columns to allow in the dashboard. Valid values range from 1 to 100. Any other value will be treated as 100.
 {panel}
  
 *row* The 1-relative row position of this pane. If set to 0, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events. The default value is 0.
  
 *column* The 1-relative column position of this pane. If set to 0 or if the value is greater than 'maxColumns' in the parent dashboard component, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events. The default value is 0.
  
 *sizeX* The horizontal size of this pane as the number columns it occupies. The default value is 1.
  
 *sizeY* The vertical size of the pane as the number of rows it occupies. The default value is 1.
  
 *closable* Specifies whether this pane can be closed or not. If true, a close button will be rendered at the upper right corner of the pane header. The default value is false.
  
 *headerText* The text to render in the header of the pane. If no header text is specified and no header facet is defined, the header will not be rendered.
  
 *footerText* The text to render in the footer of the pane. If no footer text is specified and no footer facet is defined, the header will not be rendered.
  
 h2. Client Behavior Events
  
 | dragStop | Fired when the pane is dragged and dropped by the user. | org.icefaces.ace.event.DashboardDragStopEvent |
 | resize | Fired when the pane is resized by the user. | org.icefaces.ace.event.DashboardResizeEvent |
 | close | Fired when the pane is closed by the user. | org.icefaces.ace.event.CloseEvent |
  
 h2. JavaScript APIs
  
 See the same section for [ace:dashboard|Dashboard|].
  
 h2. Keyboard and ARIA Support
  
  Not supported at the moment.
  Ability to tab through the close buttons as well as button roles for them.
  
 h2. Known Issues
  
 None at the momeny

© Copyright 2018 ICEsoft Technologies Canada Corp.