up: ZWT     index Zimbu documentation

CLASS ZWT.ScrollPanel EXTENDS ZWT.Panel @public

summary

     

A panel that provides control over scrollbars.

By default scollbars appear when needed. This can be changed with setAlwaysShowScrollbars()

NEW(item) @public  Create a ScrollPanel containing item
$setAlwaysShowScrollbars(always) @public  Set whether to always show the scrollbars.
$scrollHorizontal(px) @public  Scroll horizontally to pixel offset px.
$scrollRight() @public  Scroll horizontally to the far right.
$scrollLeft() @public  Scroll horizontally to the far left.
$getHorizontalScroll() int @public  Get the current vertical scroll position in pixels.
$scrollVertical(px) @public  Scroll vertically to pixel offset px.
$scrollTop() @public  Scroll vertically to the top.
$scrollBottom() @public  Scroll vertically to the bottom.
$getVerticalScroll() int @public  Get the current vertical scroll position in pixels.
$ensureVisible(w) @public  Ensure that w is visible by scrolling horizontally and/or vertically.
$ensureVisibleVertical(w) @public  Ensure that w is visible by scrolling vertically only.
$ensureVisibleHorizontal(w) @public  Ensure that w is visible by scrolling horizontally only.
 
Inherited from ZWT.Panel:
list<ZWT.Widget>  $items @public  The widgets inside this panel.
int  $highlighted @protected 
 
NEW() @public  Create an empty Panel.
$detach() @public  Detach the contents from Panel. Allows for faster updates, if the Panel supports it.
$attach() @public  Re-attach the contents to Panel. Only to be called after $detach().
$add(widget) @public  Add widget to end of the Panel.
$add(widget, style) @public  Add widget to end of the panel and set the style.
$addItem(widget) @public  Add widget to the list of widgets without adding it to the Panel.
$insert(widget) @public  Insert widget at the start of the panel.
$insert(widget, index) @public  Insert widget before position index. When using zero it will appear before the widgets already present.
$insertItem(widget, index) @public  Insert widget to the list of widgets without adding it to the Panel.
$set(widget, index) @public  Set widget at index in the panel.
$remove(widget) @public  Remove widget from this Panel.
$remove(index) ZWT.Widget @public  Remove the widget at index from this Panel.
$clear() @public  Remove all widgets from this Panel.
$setStyle(widget, style) @public  Set the Style for Widget w, which must be in this Panel.
$setController(controller) @public  Set the controller for this Panel. Use NIL to detach the controller.
$getController() ZWT.I_Controller @public  Get the controller for this Panel, as previously set with setController. Can be NIL.
$getHighlighted() ZWT.Widget @public  Return the first highlighted item. NIL if there is none.
$getHighlightIndex() int @public  Return the index of the first highlighted item. -1 if there is none.
$getHightlightSet() set<int> @public  Return a set with indexes of all highlighted items. Empty set if there is none.
$setHighlightStyle(style) @public  Set the Style to be used for the highlighted item.
$setHighlighted(item) @public  Set the highlight to item. Remove highlight when item is NIL.
$setHighlighted(index) @public  Set the highlight to the item with index index.
$addHighlighted(index) @public  Highlight an item without removing any existing highlight.
$removeHighlight() @public  Remove highlighting from items, if there is any.
 
Inherited from ZWT.Widget:
$getParent() UIObject @public  Return the parent of this Widget.
$ToString() string @public  Returns "Widget". Should be replaced by subclasses.
$getText() string @public  Return the text of the Widget. NIL if there is none.
$setHoverText(text) ZWT.Widget @public  Set the text to be displayed on hover-over.
$getHoverText() string @public  Get the text to be displayed on hover-over.
$addToParent(parent) @public  Add this widget to parent.
$removeFromParent() @public  Remove this Widget from its parent.
$setHandler(eventType, handler) @public  Set handler as the only method to be invoked for eventType.
$addHandler(eventType, handler) @public  Add handler as a method to be invoked for eventType.
$setClickHandler(handler) @public  Set handler as the method to be invoked for a click event on this widget.
$setMouseOverHandler(handler) @public  Set handler as the method to be invoked when the mouse enters the area of this widget.
$setMouseOutHandler(handler) @public  Set handler as the method to be invoked when the mouse leaves the area of this widget.
$setKeyHandler(handler) @public  Set handler to be invoked when a key is typed in this widget.
$setKeyDownHandler(handler) @public  Set handler to be invoked when a key is pressed in this widget.
$setKeyUpHandler(handler) @public  Set handler to be invoked when a key is released in this widget.
$setActive(active) @public  Set whether the Widget handles click events.
$isActive() bool @public  Return whether the Widget was set to be active.
$setInactiveStyle(style) @public  Set the style to be used when the Widget is inactive.
 
Inherited from ZWT.UIObject:
ZWT.Element  $elem @public  The HTML element for this Item.
 
$setStyle(style) @public  Set the main Style for this UIObject to style.
$setStyleList(styles) @public  Set the list of Styles for this UIObject to styles.
$addStyle(style) @public  Add style to this UIObject, keeping previously set ones.
$removeStyle(style) @public  Remove style from this UIObject.
$getStyle() ZWT.Style @public  Return the main Style for this UIObject.
$getStyleList() list<ZWT.Style> @public  Return the list of Styles for this UIObject.
$getWidth() int @public  Return the width of the Element.
$getHeight() int @public  Return the height of the Element.
$getTop() int @public  Return the vertical position of the Element in the page
$getTop(container) int @public  Return the vertical position of the Element within container
$getLeft() int @public  Return the horizontal position of the Element in the page
$getLeft(container) int @public  Return the horizontal position of the Element within container
$setHidden(hidden) @public  Set the item to be hidden or displayed.
 

members (alphabetically)

     

PROC NEW(ZWT.Widget item) @public

     

Create a ScrollPanel containing item

PROC $ensureVisible(ZWT.UIObject w) @public

     

Ensure that w is visible by scrolling horizontally and/or vertically.

If possible, w is centered in the viewable space.

PROC $ensureVisibleHorizontal(ZWT.UIObject w) @public

     

Ensure that w is visible by scrolling horizontally only.

If possible, w is centered in the viewable space horizontally.

PROC $ensureVisibleVertical(ZWT.UIObject w) @public

     

Ensure that w is visible by scrolling vertically only.

If possible, w is centered in the viewable space vertically.

FUNC $getHorizontalScroll() int @public

     

Get the current vertical scroll position in pixels.

FUNC $getVerticalScroll() int @public

     

Get the current vertical scroll position in pixels.

PROC $scrollBottom() @public

     

Scroll vertically to the bottom.

PROC $scrollHorizontal(int px) @public

     

Scroll horizontally to pixel offset px.

Use 0 to scroll to the far left.

PROC $scrollLeft() @public

     

Scroll horizontally to the far left.

PROC $scrollRight() @public

     

Scroll horizontally to the far right.

PROC $scrollTop() @public

     

Scroll vertically to the top.

PROC $scrollVertical(int px) @public

     

Scroll vertically to pixel offset px.

Use 0 to scroll to the top.

PROC $setAlwaysShowScrollbars(bool always) @public

     

Set whether to always show the scrollbars.

Unfortunately this is not separate for vertical and horizontal. If you need this, create a ScrollPanel inside another one.

credits

      The Class hierarchy, generated Javascript and a few other things are based on the Google Web Toolkit. http://code.google.com/webtoolkit/overview.html

license

      Copyright 2009 Bram Moolenaar All Rights Reserved.

      Licensed under the Apache License, Version 2.0. See the LICENSE file or obtain a copy at: http://www.apache.org/licenses/LICENSE-2.0