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

http://alageospatialportal.googlecode.com/ · Java · 88 lines · 11 code · 10 blank · 67 comment · 0 complexity · 463859a5e554bee5a77ba744d69b6d20 MD5 · raw file

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