zul

Class WScroll

java.lang.Object

zk.Object

zul.WScroll

public class WScroll
extends Object

A wave Scrollbar used to scroll the specific content and provides four controls to navigate the content, such as Home/Previous/Next/End, and also supports the mousewheel control.

Field Summary

Fields

Modifier and Type	Field and Description
DOMElement	control The control object for this scrolling that user can scroll the whole content
Map	opts The opts of this scrollbar controls.
Widget	widget The widget object that owns the control object.

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
static void	easing() Sets the easing animation function for the scrolling effects.
void	syncSize(Map opts) Syncs the scrolling area and control bar size.

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

control

public DOMElement control

The control object for this scrolling that user can scroll the whole content

widget

public Widget widget

The widget object that owns the control object.

opts

public Map opts

The opts of this scrollbar controls.

startPosition

int startPosition

Specifies the start position according to the scrolling area, like offset top for the vertical scrolling and offset left for the horizental scrolling.

startStep

int startStep

Specifies the start step for the scrolling.

Note: it cannot be negative.

endStep

int endStep

Specifies how many steps for the scrolling.

Note: it cannot be negative.

viewport

int viewport

Specifies how many steps will show in the viewport.

Note: it cannot be negative.

viewportSize

int viewportSize

Specifies how many pixels for the viewport size, like offsetHeight for vertical scrolling and offsetWidth for horizental scrolling.

Note: it cannot be negative.

orient

String orient

Specifies either 'vertical' or 'horizontal' to indicate that it can be scrolled only in the vertical or horizontal direction.

Default: 'horizontal'

anchor

DOMElement anchor

Specifies the anchor that indicates the scrollbar will be its child node.

Default: the parent node of the control.

syncSize

boolean syncSize

Specifies whether to sync the scrolling area size at initial phase.

Default: true.

onScrollY

void onScrollY(int step);

Specifies the callback function for the vertical scrolling, when user changes the vertical scrolling step.

onScrollX

void onScrollX(int step);

Specifies the callback function for the horizental scrolling, when user changes the horizental scrolling step.

offset

int offset

Specifies the offset for the scrolling step to shift when the callback functions (onScrollX and onScrollY) are invoked. For example, if the offset is 2, then the steps in the onScrollX/Y event will start at 2.

Default: 0

Method Detail

syncSize

public void syncSize(Map opts)

Syncs the scrolling area and control bar size.

Parameters:

opts - the opts can override the initail opts data for resizing.

easing

public static void easing()

Sets the easing animation function for the scrolling effects. For more details, please refer to jquery's easing plugin. http://gsgd.co.uk/sandbox/jquery/easing/