Name

hscrollbar — Provides a horizontal scrollbar.

Synopsis

LZX: hscrollbar
JavaScript: hscrollbar
Type: Class
Access: public
Topic: Components.Laszlo Components
Declared in: lps/components/lz/hscrollbar.lzx

Description

A scrollbar manipulates the x or y position of a target view that is clipped by its parent, creating a scrolling effect when the user clicks up/down arrows, clicks on the scroll track or drags the thumb.

This tag creates a horizontal scrollbar. If you do not specify a scrolltarget the scrollbar will automatically be aligned to the bottom and size its width to its parent's width. It is expected that the parent view be smaller than the scrolltarget and set clip=true. The scrolling effect is produced by moving the scrolltarget while its visible region is clipped by the parent view.

If you would like the target view to start scrolled, simply set its x position to a negative number. For example, x=-10 will cause the view to be scrolled 10 pixels.

[Note] Note
If you have no vertical scrollbars in your application, using the hscrollbar tag will make the applications slightly smaller than if you were to use <scrollbar axis="x">.

Example 45. Simple scrollbar

          <canvas height="100">
          <view name="main" width="100" height="90" clip="true">
          <view name="contents">
          <text width="200"  height="70" multiline="true" >
          Remember not only to say the right thing in the right place,
          but far more difficult still, to leave unsaid the wrong thing
          at the tempting moment.
          -- Benjamin Franklin
          </text>
          </view>
          <hscrollbar/>
          </view>
          </canvas>
        

In the example above, the scrolltarget is the 'contents' view. A scrollbar moves its scrolltarget along its axis. The attribute that is controlled by the scrollbar may be specified as the scrollattr, overriding the default value of x or y.

A scrollbar manipulates the x or y position of a target view that is clipped by its parent, creating a scrolling effect when the user clicks up/down arrows, clicks on the scroll track or drags the thumb.

Superclass Chain

node (LzNode) » view (LzView) » basecomponent » basescrollbar » hscrollbar

Known Subclasses

Details

Properties (2)

disabledbgcolor
<attribute name="disabledbgcolor" value="null" />
public var disabledbgcolor;
If this is defined, it will be used as the scrollbar's background color when it is disabled. If not provided, the scrollbar will use the bgcolor of its closest parent that has a bgcolor defined.
height
<attribute name="height" value="14" />
public var height;

LZX Synopsis

<class name="hscrollbar" extends=" basescrollbar ">
  <attribute name=" disabledbgcolor " value="null" />
  <attribute name=" height " value="14" />
</class>

JavaScript Synopsis

public hscrollbar extends  basescrollbar  {
  public var disabledbgcolor ;
  public var height ;
}