SplitPane

Version 7 by Ken Fyten
on Nov 13, 2014 12:26.


compared with
Current by Arturo Zambrano
on Dec 11, 2014 04:17.


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

View page history


There are 2 changes. View first change.

 h2. Overview
 _Since 4.0_
  
 The ace:splitPane component is a container that renders a {{<div>}} element divided into a left and a right pane, which in turn can include any arbitrary content.
  
 {tip}See the ICEfaces Showcase [Live Demo|http://icefaces-showcase.icesoft.org/showcase.jsf?grp=aceMenu&exp=splitPaneBean] of this component, complete with source code.{tip}
  
 h2. Getting Started
  
 To use the SplitPane component nest two facets inside the ace:splitPane tag, one named 'left' and another named 'right'. These facets can include any arbitrary content and components.
  
 {code:xml}
 <ace:splitPane id="splitPane" scrollable="true" columnDivider="50">
  
  <f:facet name="left" id="leftFacet">
  <h:outputText value="Left pane content" />
  </f:facet>
  
  <f:facet name="right" id="rightFacet">
  <h:outputText value="Right pane content" />
  </f:facet>
  
 </ace:splitPane>
 {code}
  
 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://res.icesoft.org/docs/v4_latest/ace/tld/ace/splitPane.html].{tip}
  
 {panel}
 The *scrollable* flag determines if both panes are scrollable.
 {panel}
  
 {panel}
 The *columnDivider* attribute is used to specify the percentage of the total width of the component that will be given to the left pane.
 {panel}
  
 h2. Event Listeners
  
 None.
  
 h2. Client Behavior Events
  
 None.
  
 h2. JavaScript API
  
 None.
  h4. ICEfaces 3.x
  
 The client side component object is exposed through the global variable name specified in the *widgetVar* attribute.
  
 h4. ICEfaces 4+
  
 The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.
  
 {code}var widget = ice.ace.instance('frm:componentId);{code}
  
 {tip}The _ice.ace.instance_ function requires the _full_ client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use {{prependId="false"}} in the enclosing form (e.g. _<h:form prependId="false">_).{tip}
  
 {info}This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.
 {info}
  
 h2. Keyboard Support
  
 None.
  
 h2. Known Issues
  
 None.
  
 h2. CSS Classes
  
 The following markup represents the basic HTML structure of the component and the CSS classes it uses.
  
 {code:xml}
 <!-- Root container -->
 <div class="ui-widget ace-splitpane [user defined classes]" style="[user defined styles]">
  <!-- Left pane -->
  <div class="ui-widget-content ace-splitpane-scrollable [user defined classes]">
  <!-- Left pane content -->
  </div>
  <!-- Right pane -->
  <div class="ui-widget-content ace-splitpane-scrollable [user defined classes]">
  <!-- Right pane content -->
  </div>
 </div>
 {code}
 h2. Additional Resources
  
  
 h4. Tutorials
  
 This component appears in the following ICEfaces tutorials:
  
 *None*

© Copyright 2018 ICEsoft Technologies Canada Corp.