/zk-rangeslider/src/main/java/org/zkoss/zul/api/Rangeslider.java

 1/* Rangeslider.java
 2 *
 3 * This is a modified a copy of Slider.java
 4 */
 5package org.zkoss.zul.api;
 6
 7import org.zkoss.zk.ui.WrongValueException;
 8
 9/**
10 * A slider with both a min and max handle.
11 * <p>
12 * Default {@link #getZclass} as follows: (since 3.5.0)
13 * <ol>
14 * <li>Case 1: If {@link #getOrient()} is vertical, "z-slider-ver" is assumed</li>
15 * <li>Case 2: If {@link #getOrient()} is horizontal, "z-slider-hor" is assumed</li>
16 * </ol>
17 */
18public interface Rangeslider extends org.zkoss.zul.impl.api.XulElement {
19
20	/**
21	 * Returns the orient.
22	 * <p>
23	 * Default: "horizontal".
24	 */
25	public String getOrient();
26
27	/**
28	 * Sets the orient.
29	 * <p>
30	 * Default : "horizontal"
31	 * 
32	 * @param orient
33	 *            either "horizontal" or "vertical".
34	 */
35	public void setOrient(String orient) throws WrongValueException;
36
37	/**
38	 * Returns the sliding text.
39	 * <p>
40	 * Default : "{0}"
41	 * 
42	 */
43	public String getSlidingtext();
44
45	/**
46	 * Sets the sliding text. The syntax "{0}" will be replaced with the
47	 * position at client side.
48	 * 
49	 */
50	public void setSlidingtext(String slidingtext);
51
52	/**
53	 * Returns whether it is a vertical slider.
54	 * 
55	 */
56	public boolean isVertical();
57
58	/**
59	 * Returns the name of this component.
60	 * <p>
61	 * Default: null.
62	 * <p>
63	 * The name is used only to work with "legacy" Web application that handles
64	 * user's request by servlets. It works only with HTTP/HTML-based browsers.
65	 * It doesn't work with other kind of clients.
66	 * <p>
67	 * Don't use this method if your application is purely based on ZK's
68	 * event-driven model.
69	 * 
70	 */
71	public String getName();
72
73	/**
74	 * Sets the name of this component.
75	 * <p>
76	 * The name is used only to work with "legacy" Web application that handles
77	 * user's request by servlets. It works only with HTTP/HTML-based browsers.
78	 * It doesn't work with other kind of clients.
79	 * <p>
80	 * Don't use this method if your application is purely based on ZK's
81	 * event-driven model.
82	 * 
83	 * @param name
84	 *            the name of this component.
85	 */
86	public void setName(String name);
87
88}