Rangeslider"

From Documentation
(Created page with "{{ZKComponentReferencePageHeader}} = Rangeslider = *Demonstration: *Java API: [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Rangeslider.html Rangeslider] *JavaS...")
 
(23 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
*Demonstration:  
 
*Demonstration:  
*Java API: [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Rangeslider.html Rangeslider]  
+
*Java API: [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkex/zul/Rangeslider.html Rangeslider]  
*JavaScript API: [http://www.zkoss.org/javadoc/latest/jsdoc/zkmax/slider/Rangeslider.html Rangeslider]  
+
*JavaScript API: [http://www.zkoss.org/javadoc/latest/jsdoc/zkex/slider/Rangeslider.html Rangeslider]  
*{{ZK EE}}
+
{{ZK PE}}
 +
since 9.0.0
  
 
= Employment/Purpose =
 
= Employment/Purpose =
  
This component synchronizes the scrolling position on a page or within ZK containers (Div, Window, etc.) with hyperlinks and buttons. It allows you both to navigate to desired ZK components in a page and highlight the current navigation link based on the current scroll position.
+
A rangeslider component represents a slider with a start and an end value. A rangeslider accepts a range of value starting from 0 to a certain maximum value. The default maximum value of rangeslider is 100. You can change the maximum allowed value by setting the max property. Notice that the value of max property is always larger than the value of min property.
  
 
= Example =
 
= Example =
 
+
[[Image:ZKComRef_Rangeslider.png]]
 
<source lang="xml" >
 
<source lang="xml" >
<zk xmlns:ca="client/attribute">
+
<zk>
   <anchornav name="a1" width="250px">
+
   <rangeslider startValue="10" endValue="90"/>
        <listbox>
+
  <separator />
            <listitem><listcell><a ca:data-anchornav-target="$win1"> First Window </a></listcell></listitem>
+
   <rangeslider orient="vertical" startValue="20" endValue="80" markScale="20" />
            <listitem><listcell><a ca:data-anchornav-target="$win2"> Second Window </a></listcell></listitem>
 
            <listitem><listcell><a ca:data-anchornav-target="$win3"> Third Window </a></listcell></listitem>
 
        </listbox>
 
    </anchornav>
 
   <window id="win1" title="1. First Window">
 
    Hello world.
 
  </window>
 
  <window id="win2" title="2. Second Window">
 
    Welcome to ZK world.
 
  </window>
 
 
</zk>
 
</zk>
 
</source>
 
</source>
  
By default, the Anchornav component will watch the scroll position of a page.
+
= Properties =
Other scrollable containers can be associated with a named Anchornav by setting the client-attribute: ca:data-anchornav-scroll.
+
 
 +
== Disabled ==
 +
If the rangeslider is disabled, then users can not drag the slider buttons.
 +
 
 +
== Orient ==
 +
Sets the orient either "horizontal" or "vertical" to display rangslider.
 +
 
 +
== Marks ==
 +
Sets the marks information map for displaying value marks. (Default: null)
 +
In this map, the key represents the number value of slider, and the value represents the displayed scale text.
 +
 
 +
== MarkScale ==
 +
Sets the marks information for displaying value marks (Default: "20").
 +
 
 +
By default, the value marks will be displayed every 20 starting from the minimum value. (if min is 0, then it displays "0 20 40 ...")
 +
 
 +
 
 +
If the MarkScale is 0 and there is no Map information in Marks (see above), the marks will be empty.
  
For example:
+
[[Image:ZKComRef_RangesliderNoMarks.png]]
<source lang="xml" >
 
<div ca:data-anchornav-scroll="a1">
 
    <!-- other components -->
 
</div>
 
</source>
 
  
A or Button components can be used as links and targets are specified by the ZK client-attribute ca:data-anchornav-target=[selector].
+
== Max ==
For example, in Line 3 and Line 4, $win1 / $win2 select widgets by zk component id, win1 / win2.
+
Rangeslider supports maximal position, which can be changed by the max property.
 +
(Default: 100)
  
The JQuery-based selector syntax (#domId / .class / elementName) is extended by ZK specific selectors as seen above using $componentId or @componentName.
+
== Min ==
 +
Rangeslider supports minimal position, which can be changed by the min property.
 +
(Default: 0)
  
= Properties =
+
== StartValue, EndValue ==
 +
Represent the range value of Rangeslider.
 +
(Default: 0)
  
== Name ==
+
== Step ==
Set the name of Anchornav, it is only required when we want to spy scrolling in ZK containers instead of the whole page scrollbar.
+
By default, the rangeslider will scroll to the position continuously when a user drags it. If you prefer to scroll a discrete fixed amount at each step, you can set the amount of value using the step property.
  
== PositionFixed ==
+
== TooltipVisible ==
Set whether to enable position fixed when anchornav is out of current view. When it is set to true, Anchornav will stay (float) on the same position of the page. (Default: true)
+
The tooltip displays the value of a slider button in the rangeslider.
 +
If the tooltipvisible is true, the tooltips of the slider buttons will always be visible.
 +
(Default: false)
  
= Supported Events =
+
=Supported Events=
  
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/LabelImageElement#Supported_Events | LabelImageElement]]
+
{| border="1" | width="100%"
 +
! <center>Name</center>
 +
! <center>Event Type</center>
 +
|-
 +
| <center>onRangeValueChange</center>
 +
| '''Event:''' <javadoc>org.zkoss.zkex.zul.event.RangeValueChangeEvent</javadoc>
 +
Denotes the range value of a component has been changed by the user.
 +
|}
 +
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/XulElement#Supported_Events | XulElement]]
  
= Supported Children =
+
=Supported Children=
  
  *[[ZK_Component_Reference/Essential_Components/Nav | Nav]], [[ZK_Component_Reference/Essential_Components/Nav/Navitem  | Navitem]],[[ZK_Component_Reference/Essential_Components/Nav/Navseparator  | Navseparator]]
+
  *None
  
 
= Use Cases =
 
= Use Cases =
Line 81: Line 99:
 
| 9.0.0
 
| 9.0.0
 
| November, 2019
 
| November, 2019
| [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Anchornav.html Anchornav] was introduced.
+
| [http://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Rangeslider.html Rangeslider] was introduced.
 
|}
 
|}
  
 
{{ZKComponentReferencePageFooter}}
 
{{ZKComponentReferencePageFooter}}

Revision as of 03:09, 29 November 2019

Rangeslider

  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion pe-ee.png
since 9.0.0

Employment/Purpose

A rangeslider component represents a slider with a start and an end value. A rangeslider accepts a range of value starting from 0 to a certain maximum value. The default maximum value of rangeslider is 100. You can change the maximum allowed value by setting the max property. Notice that the value of max property is always larger than the value of min property.

Example

ZKComRef Rangeslider.png

<zk>
  <rangeslider startValue="10" endValue="90"/>
  <separator />
  <rangeslider orient="vertical" startValue="20" endValue="80" markScale="20" />
</zk>

Properties

Disabled

If the rangeslider is disabled, then users can not drag the slider buttons.

Orient

Sets the orient either "horizontal" or "vertical" to display rangslider.

Marks

Sets the marks information map for displaying value marks. (Default: null) In this map, the key represents the number value of slider, and the value represents the displayed scale text.

MarkScale

Sets the marks information for displaying value marks (Default: "20").

By default, the value marks will be displayed every 20 starting from the minimum value. (if min is 0, then it displays "0 20 40 ...")


If the MarkScale is 0 and there is no Map information in Marks (see above), the marks will be empty.

ZKComRef RangesliderNoMarks.png

Max

Rangeslider supports maximal position, which can be changed by the max property. (Default: 100)

Min

Rangeslider supports minimal position, which can be changed by the min property. (Default: 0)

StartValue, EndValue

Represent the range value of Rangeslider. (Default: 0)

Step

By default, the rangeslider will scroll to the position continuously when a user drags it. If you prefer to scroll a discrete fixed amount at each step, you can set the amount of value using the step property.

TooltipVisible

The tooltip displays the value of a slider button in the rangeslider. If the tooltipvisible is true, the tooltips of the slider buttons will always be visible. (Default: false)

Supported Events

Name
Event Type
onRangeValueChange
Event: RangeValueChangeEvent

Denotes the range value of a component has been changed by the user.

Supported Children

*None

Use Cases

Version Description Example Location
     

Version History

Last Update : 2019/11/29


Version Date Content
9.0.0 November, 2019 Rangeslider was introduced.



Last Update : 2019/11/29

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.