qx.ui.basic
Class ScrollBar

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.ui.core.Widget
              qx.ui.core.Parent
                  qx.ui.layout.CanvasLayout
                      qx.ui.basic.ScrollBar

public class ScrollBar
extends CanvasLayout

A scroll bar.

Field Summary

Fields inherited from class qx.ui.core.Widget

AUTO

Constructor Summary

ScrollBar()

ScrollBar(boolean horizontal)

Method Summary

void	_afterAppear()
void	_applyEnabled(boolean isEnabled, boolean old) Applies changes of the property value of the property enabled.
void	_applyMaximum(java.lang.Integer value, java.lang.Integer old) Applies changes of the property value of the property maximum.
void	_applyValue(int value, int old) Applies changes of the property value of the property value.
void	_applyVisibility(boolean value, boolean old) Applies changes of the property value of the property visibility.
int	_checkValue(int value) Limit the value to the allowed range of the scroll bar.
java.lang.Integer	_computePreferredInnerHeight() overridden
java.lang.Integer	_computePreferredInnerWidth() overridden
java.lang.Integer	_getScrollBarWidth() Gets the width of vertical scroll bar.
void	_onscroll(java.lang.Object evt) Event handler.
void	_positionKnob(java.lang.Integer value) Positions the scroll bar knob at a certain value.
java.lang.Integer	getMaximum() Returns the (computed) value of the property maximum.
boolean	getMergeEvents() Returns the (computed) value of the property mergeEvents.
int	getValue() Returns the (computed) value of the property value.
void	initMaximum(java.lang.Integer arg) Calls the apply method and dispatches the change event of the property maximum with the default value defined by the class developer.
void	initMergeEvents(boolean arg) Calls the apply method and dispatches the change event of the property mergeEvents with the default value defined by the class developer.
void	initValue(int arg) Calls the apply method and dispatches the change event of the property value with the default value defined by the class developer.
boolean	isMergeEvents() Check whether the (computed) value of the boolean property mergeEvents equals true.
void	resetMaximum() Resets the user value of the property maximum.
void	resetMergeEvents() Resets the user value of the property mergeEvents.
void	resetValue() Resets the user value of the property value.
void	setMaximum(java.lang.Integer arg) Sets the user value of the property maximum.
void	setMergeEvents(boolean arg) Sets the user value of the property mergeEvents.
void	setValue(int arg) Sets the user value of the property value.
boolean	toggleMergeEvents() Toggles the (computed) value of the boolean property mergeEvents.

Methods inherited from class qx.ui.layout.CanvasLayout

_createLayoutImpl

Methods inherited from class qx.ui.core.Parent

_addChildrenToLayoutQueue, _addChildrenToStateQueue, _addChildToChildrenQueue, _afterDisappear, _afterInsertDom, _afterRemoveDom, _applyActiveChild, _applyFocusedChild, _applyFocusHandler, _beforeAppear, _beforeDisappear, _beforeInsertDom, _beforeRemoveDom, _changeInnerHeight, _changeInnerWidth, _computeVisibleChildren, _flushChildrenQueue, _handleDisplayableCustom, _layoutChild, _layoutPost, _onfocuskeyevent, _recursiveAppearanceThemeUpdate, _removeChildFromChildrenQueue, activateFocusRoot, add, addAfter, addAt, addAtBegin, addAtEnd, addBefore, contains, forEachChild, forEachVisibleChild, getActiveChild, getChildren, getChildrenLength, getFirstActiveChild, getFirstChild, getFirstVisibleChild, getFocusedChild, getFocusHandler, getFocusRoot, getInnerHeightForChild, getInnerWidthForChild, getLastActiveChild, getLastChild, getLastVisibleChild, getLayoutImpl, getVisibleChildrenLength, hasChildren, hasVisibleChildren, indexOf, initActiveChild, initFocusedChild, initFocusHandler, isEmpty, isFocusRoot, isVisibleEmpty, recursiveAddToStateQueue, remapChildrenHandlingTo, remove, removeAll, removeAt, resetActiveChild, resetFocusedChild, resetFocusHandler, setActiveChild, setFocusedChild, setFocusHandler

Methods inherited from class qx.ui.core.Widget

_applyAppearance, _applyBackgroundColor, _applyBackgroundImage, _applyBackgroundRepeat, _applyBorder, _applyBottom, _applyCapture, _applyClip, _applyCommand, _applyCursor, _applyDisplay, _applyElement, _applyElementData, _applyEnabled, _applyFocused, _applyFont, _applyHeight, _applyHideFocus, _applyHtmlAttributes, _applyHtmlProperties, _applyLeft, _applyMarginBottom, _applyMarginLeft, _applyMarginRight, _applyMarginTop, _applyMaxHeight, _applyMaxWidth, _applyMinHeight, _applyMinWidth, _applyOpacity, _applyOverflow, _applyPaddingBottom, _applyPaddingLeft, _applyPaddingRight, _applyPaddingTop, _applyParent, _applyRight, _applySelectable, _applyStateStyleFocus, _applyStyleProperties, _applyTabIndex, _applyTextColor, _applyTop, _applyVisibility, _applyWidth, _applyZIndex, _checkParent, _compileClipString, _computeBoxHeight, _computeBoxHeightFallback, _computeBoxWidth, _computeBoxWidthFallback, _computeDisplayable, _computeFrameHeight, _computeFrameWidth, _computeHasAutoX, _computeHasAutoY, _computeHasFlexX, _computeHasFlexY, _computeHasPercentX, _computeHasPercentY, _computeInnerHeight, _computeInnerWidth, _computeOuterHeight, _computeOuterWidth, _computePreferredBoxHeight, _computePreferredBoxWidth, _computeValuePercentX, _computeValuePercentXLimit, _computeValuePercentY, _computeValuePercentYLimit, _computeValuePixel, _computeValuePixelLimit, _createElementImpl, _evalUnitsPixelPercent, _evalUnitsPixelPercentAuto, _evalUnitsPixelPercentAutoFlex, _flushJobQueue, _generateHtmlId, _getTargetNode, _handleDisplayable, _invalidateFrameDimensions, _invalidatePreferredInnerDimensions, _queueBorder, _recomputeFlexX, _recomputeFlexY, _recomputePercentX, _recomputePercentY, _recomputeRangeX, _recomputeRangeY, _recomputeStretchingX, _recomputeStretchingY, _renderAppearance, _renderOverflow, _resetAppearanceThemeWrapper, _styleBackgroundColor, _styleBackgroundImage, _styleFromMap, _unitDetectionPixelPercent, _unitDetectionPixelPercentAuto, _unitDetectionPixelPercentAutoFlex, _unstyleFromArray, _visualizeBlur, _visualizeFocus, _visualPropertyCheck, addState, addToDocument, addToJobQueue, addToLayoutChanges, addToQueue, addToQueueRuntime, addToStateQueue, auto, blur, connect, contains, disconnect, execute, focus, getAllowStretchX, getAllowStretchY, getAnonymous, getAppearance, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBottom, getBottomValue, getCapture, getClientHeight, getClientWidth, getClipHeight, getClipLeft, getClipTop, getClipWidth, getCommand, getContextMenu, getCursor, getDisplay, getDropDataTypes, getElement, getEnabled, getEnableElementFocus, getFocused, getFont, getHeight, getHeightValue, getHideFocus, getHorizontalAlign, getHtmlAttribute, getHtmlProperty, getLeft, getLeftValue, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getMinWidthValue, getNeededHeight, getNeededWidth, getNextActiveSibling, getNextSibling, getNextVisibleSibling, getOffsetHeight, getOffsetLeft, getOffsetTop, getOffsetWidth, getOpacity, getOverflow, getOverflowX, getOverflowY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPreviousActiveSibling, getPreviousSibling, getPreviousVisibleSibling, getRight, getRightValue, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectable, getStyleProperty, getSupportsDropMethod, getTabIndex, getTextColor, getToolTip, getTop, getTopLevelWidget, getTopValue, getVerticalAlign, getVisibility, getVisibleChildren, getWidth, getWidthValue, getZIndex, hasState, hide, indexOf, initAllowStretchX, initAllowStretchY, initAnonymous, initAppearance, initBackgroundColor, initBackgroundImage, initBackgroundRepeat, initBorder, initBottom, initCapture, initClipHeight, initClipLeft, initClipTop, initClipWidth, initCommand, initContextMenu, initCursor, initDisplay, initDropDataTypes, initElement, initEnabled, initEnableElementFocus, initFocused, initFont, initHeight, initHideFocus, initHorizontalAlign, initLeft, initMarginBottom, initMarginLeft, initMarginRight, initMarginTop, initMaxHeight, initMaxWidth, initMinHeight, initMinWidth, initOpacity, initOverflow, initPaddingBottom, initPaddingLeft, initPaddingRight, initPaddingTop, initParent, initRight, initSelectable, initSupportsDropMethod, initTabIndex, initTextColor, initToolTip, initTop, initVerticalAlign, initVisibility, initWidth, initZIndex, isAllowStretchX, isAllowStretchY, isAnonymous, isAppearRelevant, isCapture, isCreated, isDisplay, isDisplayable, isEnabled, isEnableElementFocus, isFirstChild, isFirstVisibleChild, isFocusable, isFocused, isHideFocus, isLastChild, isLastVisibleChild, isMaterialized, isSeeable, isSelectable, isVisibility, moveSelfAfter, moveSelfBefore, moveSelfToBegin, moveSelfToEnd, pack, removeHtmlAttribute, removeHtmlProperty, removeState, removeStyleProperty, renderPadding, resetAlign, resetAllowStretchX, resetAllowStretchY, resetAnonymous, resetAppearance, resetBackgroundColor, resetBackgroundImage, resetBackgroundRepeat, resetBorder, resetBottom, resetCapture, resetClip, resetClipDimension, resetClipHeight, resetClipLeft, resetClipLocation, resetClipTop, resetClipWidth, resetCommand, resetContextMenu, resetCursor, resetDimension, resetDisplay, resetDropDataTypes, resetEdge, resetElement, resetEnabled, resetEnableElementFocus, resetFocused, resetFont, resetHeight, resetHeights, resetHideFocus, resetHorizontalAlign, resetLeft, resetLocation, resetMargin, resetMarginBottom, resetMarginLeft, resetMarginRight, resetMarginTop, resetMaxHeight, resetMaxWidth, resetMinHeight, resetMinWidth, resetOpacity, resetOverflow, resetPadding, resetPaddingBottom, resetPaddingLeft, resetPaddingRight, resetPaddingTop, resetParent, resetRight, resetSelectable, resetSpace, resetSupportsDropMethod, resetTabIndex, resetTextColor, resetToolTip, resetTop, resetVerticalAlign, resetVisibility, resetWidth, resetWidths, resetZIndex, scrollIntoView, scrollIntoViewX, scrollIntoViewY, setAlign, setAllowStretchX, setAllowStretchY, setAnonymous, setAppearance, setBackgroundColor, setBackgroundImage, setBackgroundRepeat, setBorder, setBottom, setCapture, setClip, setClipDimension, setClipHeight, setClipLeft, setClipLocation, setClipTop, setClipWidth, setCommand, setContextMenu, setCursor, setDimension, setDisplay, setDropDataTypes, setEdge, setElement, setEnabled, setEnableElementFocus, setFocused, setFont, setHeight, setHeights, setHideFocus, setHorizontalAlign, setHtmlAttribute, setHtmlProperty, setLeft, setLocation, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setParent, setRight, setScrollLeft, setScrollTop, setSelectable, setSpace, setStyleProperty, setSupportsDropMethod, setTabIndex, setTextColor, setToolTip, setTop, setVerticalAlign, setVisibility, setWidth, setWidths, setZIndex, show, supportsDrop, toggleAllowStretchX, toggleAllowStretchY, toggleAnonymous, toggleCapture, toggleDisplay, toggleEnabled, toggleEnableElementFocus, toggleFocused, toggleHideFocus, toggleSelectable, toggleVisibility

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollBar

public ScrollBar()

ScrollBar

public ScrollBar(boolean horizontal)

Method Detail

_afterAppear

public void _afterAppear()

Overrides:

_afterAppear in class Parent

_applyEnabled

public void _applyEnabled(boolean isEnabled,
                          boolean old)

Applies changes of the property value of the property enabled.

For further details take a look at the property definition: _applyEnabled(boolean, boolean).

_applyMaximum

public void _applyMaximum(java.lang.Integer value,
                          java.lang.Integer old)

Applies changes of the property value of the property maximum.

For further details take a look at the property definition: _applyMaximum(java.lang.Integer, java.lang.Integer).

_applyValue

public void _applyValue(int value,
                        int old)

Applies changes of the property value of the property value.

For further details take a look at the property definition: _applyValue(int, int).

_applyVisibility

public void _applyVisibility(boolean value,
                             boolean old)

Applies changes of the property value of the property visibility.

For further details take a look at the property definition: _applyVisibility(boolean, boolean).

_checkValue

public int _checkValue(int value)

Limit the value to the allowed range of the scroll bar.

_computePreferredInnerHeight

public java.lang.Integer _computePreferredInnerHeight()

overridden

Overrides:

_computePreferredInnerHeight in class Parent

_computePreferredInnerWidth

public java.lang.Integer _computePreferredInnerWidth()

overridden

Overrides:

_computePreferredInnerWidth in class Parent

_getScrollBarWidth

public java.lang.Integer _getScrollBarWidth()

Gets the width of vertical scroll bar.

_onscroll

public void _onscroll(java.lang.Object evt)

Event handler. Called when the user scrolled.

_positionKnob

public void _positionKnob(java.lang.Integer value)

Positions the scroll bar knob at a certain value.

getMaximum

public java.lang.Integer getMaximum()

Returns the (computed) value of the property maximum.

For further details take a look at the property definition: maximum.

getMergeEvents

public boolean getMergeEvents()

Returns the (computed) value of the property mergeEvents.

For further details take a look at the property definition: mergeEvents.

getValue

public int getValue()

Returns the (computed) value of the property value.

For further details take a look at the property definition: value.

initMaximum

public void initMaximum(java.lang.Integer arg)

Calls the apply method and dispatches the change event of the property maximum with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: maximum.

initMergeEvents

public void initMergeEvents(boolean arg)

Calls the apply method and dispatches the change event of the property mergeEvents with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: mergeEvents.

initValue

public void initValue(int arg)

Calls the apply method and dispatches the change event of the property value with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: value.

isMergeEvents

public boolean isMergeEvents()

Check whether the (computed) value of the boolean property mergeEvents equals true.

For further details take a look at the property definition: mergeEvents.

resetMaximum

public void resetMaximum()

Resets the user value of the property maximum.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: maximum.

resetMergeEvents

public void resetMergeEvents()

Resets the user value of the property mergeEvents.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: mergeEvents.

resetValue

public void resetValue()

Resets the user value of the property value.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: value.

setMaximum

public void setMaximum(java.lang.Integer arg)

Sets the user value of the property maximum.

For further details take a look at the property definition: maximum.

setMergeEvents

public void setMergeEvents(boolean arg)

Sets the user value of the property mergeEvents.

For further details take a look at the property definition: mergeEvents.

setValue

public void setValue(int arg)

Sets the user value of the property value.

For further details take a look at the property definition: value.

toggleMergeEvents

public boolean toggleMergeEvents()

Toggles the (computed) value of the boolean property mergeEvents.

For further details take a look at the property definition: mergeEvents.