com.smartgwt.client.widgets
Class Scrollbar

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.StatefulCanvas
                      extended by com.smartgwt.client.widgets.StretchImg
                          extended by com.smartgwt.client.widgets.Scrollbar
All Implemented Interfaces:
HasHandlers, com.google.gwt.user.client.EventListener, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers

public class Scrollbar
extends StretchImg

The Scrollbar widget implements cross-platform, image-based scrollbars that control the scrolling of content in other widgets. Scrollbar widgets are created and displayed automatically for widgets that require them, based on settings for overflow.

The scrollbar's appearance is based on a StretchImg for the "track", which consists of two fixed size buttons and a stretchable center segment, and the com.smartgwt.client..ScrollThumb, the draggable portion of the scrollbar, also a StretchImg, with an optional showGrip.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Scrollbar()
           
Scrollbar(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 java.lang.Boolean getAllowThumbDownState()
          If true, the thumb's appearance changes when it's clicked on.
 java.lang.Boolean getAllowThumbOverState()
          If true, the thumb's appearance changes when the user rolls over it.
 java.lang.Boolean getAutoEnable()
          If true, this scrollbar will automatically enable when the scrollTarget is scrollable (i.e., when the contents of the scrollTarget exceed its clip size in the direction relevant to this scrollbar), and automatically disable when the scrollTarget is not scrollable.
 int getBtnSize()
          The size of the square buttons (arrows) at the ends of this scrollbar.
 java.lang.Integer getCornerSize()
          Allows the size of the corner segment to be set independently of the btnSize.
 java.lang.String getCornerSrc()
          URL for the corner image, a singular image that appears in the corner when both h and v scrollbars are showing.
 java.lang.Integer getEndThumbOverlap()
          Number of pixels the thumb is allowed to overlap the buttons at the end of the track. Default prevents doubling of 1px borders.
 java.lang.String getHSrc()
          Base URL for the images used for the horizontal scrollbar track and end buttons.
static Scrollbar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getShowCorner()
          If true, displays a corner piece at the bottom end of a vertical scrollbar, or the right end of a horizontal scrollbar.
 java.lang.Boolean getShowTrackEnds()
          If true, the scrollbar uses a 5-segment rather than 3-segment image representation, where the 3 interior image segments have the same state (Down, Over, etc), independent of the two outermost image segments.
 java.lang.String getSkinImgDir()
          Where are the skin images for the Scrollbar.
 java.lang.Integer getStartThumbOverlap()
          Number of pixels the thumb is allowed to overlap the buttons at the start of the track. Default prevents doubling of 1px borders.
 java.lang.Integer getThumbInset()
          Inset of the thumb relative to the track.
 int getThumbMinSize()
          The minimum pixel size of the draggable thumb regardless of how large the scrolling region becomes.
 int getThumbOverlap()
          Number of pixels the thumb is allowed to overlap the buttons at each end of the track. Default prevents doubling of 1px borders.
 int getTrackEndHeight()
          The minimum pixel height of the track end segments (if enabled with showTrackEnds).
 int getTrackEndWidth()
          The minimum pixel width of the track end segments (if enabled with showTrackEnds).
 java.lang.String getVSrc()
          Base URL for the images used for the vertical scrollbar track and end buttons.
 void setAllowThumbDownState(java.lang.Boolean allowThumbDownState)
          If true, the thumb's appearance changes when it's clicked on.
 void setAllowThumbOverState(java.lang.Boolean allowThumbOverState)
          If true, the thumb's appearance changes when the user rolls over it.
 void setAutoEnable(java.lang.Boolean autoEnable)
          If true, this scrollbar will automatically enable when the scrollTarget is scrollable (i.e., when the contents of the scrollTarget exceed its clip size in the direction relevant to this scrollbar), and automatically disable when the scrollTarget is not scrollable.
 void setBtnSize(int btnSize)
          The size of the square buttons (arrows) at the ends of this scrollbar.
 void setCornerSize(java.lang.Integer cornerSize)
          Allows the size of the corner segment to be set independently of the btnSize.
 void setCornerSrc(java.lang.String cornerSrc)
          URL for the corner image, a singular image that appears in the corner when both h and v scrollbars are showing.
 void setEndThumbOverlap(java.lang.Integer endThumbOverlap)
          Number of pixels the thumb is allowed to overlap the buttons at the end of the track. Default prevents doubling of 1px borders.
 void setHSrc(java.lang.String hSrc)
          Base URL for the images used for the horizontal scrollbar track and end buttons.
 void setShowCorner(java.lang.Boolean showCorner)
          If true, displays a corner piece at the bottom end of a vertical scrollbar, or the right end of a horizontal scrollbar.
 void setShowTrackEnds(java.lang.Boolean showTrackEnds)
          If true, the scrollbar uses a 5-segment rather than 3-segment image representation, where the 3 interior image segments have the same state (Down, Over, etc), independent of the two outermost image segments.
 void setSkinImgDir(java.lang.String skinImgDir)
          Where are the skin images for the Scrollbar.
 void setStartThumbOverlap(java.lang.Integer startThumbOverlap)
          Number of pixels the thumb is allowed to overlap the buttons at the start of the track. Default prevents doubling of 1px borders.
 void setThumbInset(java.lang.Integer thumbInset)
          Inset of the thumb relative to the track.
 void setThumbMinSize(int thumbMinSize)
          The minimum pixel size of the draggable thumb regardless of how large the scrolling region becomes.
 void setThumbOverlap(int thumbOverlap)
          Number of pixels the thumb is allowed to overlap the buttons at each end of the track. Default prevents doubling of 1px borders.
 void setTrackEndHeight(int trackEndHeight)
          The minimum pixel height of the track end segments (if enabled with showTrackEnds).
 void setTrackEndWidth(int trackEndWidth)
          The minimum pixel width of the track end segments (if enabled with showTrackEnds).
 void setVSrc(java.lang.String vSrc)
          Base URL for the images used for the vertical scrollbar track and end buttons.
 
Methods inherited from class com.smartgwt.client.widgets.StretchImg
getCapSize, getImageType, getItemBaseStyle, getShowGrip, getShowTitle, getSrc, getVertical, setCapSize, setImageType, setItemBaseStyle, setShowGrip, setShowTitle, setSrc, setState, setState, setVertical
 
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas
addToRadioGroup, deselect, getActionType, getAlign, getAutoFit, getBaseStyle, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconWidth, getOverCanvasConstructor, getRadioGroup, getRedrawOnStateChange, getSelected, getShowDisabled, getShowDisabledIcon, getShowDown, getShowDownIcon, getShowFocused, getShowFocusedAsOver, getShowFocusedIcon, getShowOverCanvas, getShowRollOver, getShowRollOverIcon, getShowSelectedIcon, getState, getStateSuffix, getTitle, getValign, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAlign, setAutoFit, setBaseStyle, setDisabled, setIcon, setIconHeight, setIconOrientation, setIconSize, setIconWidth, setOverCanvasConstructor, setRadioGroup, setRedrawOnStateChange, setSelected, setShowDisabled, setShowDisabledIcon, setShowDown, setShowDownIcon, setShowFocused, setShowFocusedAsOver, setShowFocusedIcon, setShowOverCanvas, setShowRollOver, setShowRollOverIcon, setShowSelectedIcon, setState, setTitle, setTitleStyle, setValign
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

Scrollbar

public Scrollbar()

Scrollbar

public Scrollbar(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static Scrollbar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class StretchImg

setBtnSize

public void setBtnSize(int btnSize)
The size of the square buttons (arrows) at the ends of this scrollbar. This overrides the width of a vertical scrollbar or the height of a horizontal scrollbar to set the scrollbar's thickness.

Parameters:
btnSize - btnSize Default value is 16

getBtnSize

public int getBtnSize()
The size of the square buttons (arrows) at the ends of this scrollbar. This overrides the width of a vertical scrollbar or the height of a horizontal scrollbar to set the scrollbar's thickness.

Returns:
int

setAutoEnable

public void setAutoEnable(java.lang.Boolean autoEnable)
If true, this scrollbar will automatically enable when the scrollTarget is scrollable (i.e., when the contents of the scrollTarget exceed its clip size in the direction relevant to this scrollbar), and automatically disable when the scrollTarget is not scrollable. Set this property to false for full manual control over a scrollbar's enabled state.

Note : This is an advanced setting

Parameters:
autoEnable - autoEnable Default value is true

getAutoEnable

public java.lang.Boolean getAutoEnable()
If true, this scrollbar will automatically enable when the scrollTarget is scrollable (i.e., when the contents of the scrollTarget exceed its clip size in the direction relevant to this scrollbar), and automatically disable when the scrollTarget is not scrollable. Set this property to false for full manual control over a scrollbar's enabled state.

Returns:
Boolean

setShowCorner

public void setShowCorner(java.lang.Boolean showCorner)
                   throws java.lang.IllegalStateException
If true, displays a corner piece at the bottom end of a vertical scrollbar, or the right end of a horizontal scrollbar. This is typically set only when both horizontal and vertical scrollbars are displayed and about the same corner.

Note : This is an advanced setting

Parameters:
showCorner - showCorner Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowCorner

public java.lang.Boolean getShowCorner()
If true, displays a corner piece at the bottom end of a vertical scrollbar, or the right end of a horizontal scrollbar. This is typically set only when both horizontal and vertical scrollbars are displayed and about the same corner.

Returns:
Boolean

setAllowThumbDownState

public void setAllowThumbDownState(java.lang.Boolean allowThumbDownState)
                            throws java.lang.IllegalStateException
If true, the thumb's appearance changes when it's clicked on.

Note : This is an advanced setting

Parameters:
allowThumbDownState - allowThumbDownState Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getAllowThumbDownState

public java.lang.Boolean getAllowThumbDownState()
If true, the thumb's appearance changes when it's clicked on.

Returns:
Boolean

setAllowThumbOverState

public void setAllowThumbOverState(java.lang.Boolean allowThumbOverState)
                            throws java.lang.IllegalStateException
If true, the thumb's appearance changes when the user rolls over it.

Note : This is an advanced setting

Parameters:
allowThumbOverState - allowThumbOverState Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getAllowThumbOverState

public java.lang.Boolean getAllowThumbOverState()
If true, the thumb's appearance changes when the user rolls over it.

Returns:
Boolean

setShowTrackEnds

public void setShowTrackEnds(java.lang.Boolean showTrackEnds)
                      throws java.lang.IllegalStateException
If true, the scrollbar uses a 5-segment rather than 3-segment image representation, where the 3 interior image segments have the same state (Down, Over, etc), independent of the two outermost image segments.

This allows certain advanced skinning designs where the track-as-such (space in which the thumb may be dragged) has curved endcaps, and is also visually stateful (that is, changes when the mouse goes down, without affecting the appearance of the outermost segments).

Note : This is an advanced setting

Parameters:
showTrackEnds - showTrackEnds Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowTrackEnds

public java.lang.Boolean getShowTrackEnds()
If true, the scrollbar uses a 5-segment rather than 3-segment image representation, where the 3 interior image segments have the same state (Down, Over, etc), independent of the two outermost image segments.

This allows certain advanced skinning designs where the track-as-such (space in which the thumb may be dragged) has curved endcaps, and is also visually stateful (that is, changes when the mouse goes down, without affecting the appearance of the outermost segments).

Returns:
Boolean

setThumbMinSize

public void setThumbMinSize(int thumbMinSize)
                     throws java.lang.IllegalStateException
The minimum pixel size of the draggable thumb regardless of how large the scrolling region becomes.

Note : This is an advanced setting

Parameters:
thumbMinSize - thumbMinSize Default value is 12
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getThumbMinSize

public int getThumbMinSize()
The minimum pixel size of the draggable thumb regardless of how large the scrolling region becomes.

Returns:
int

setTrackEndWidth

public void setTrackEndWidth(int trackEndWidth)
                      throws java.lang.IllegalStateException
The minimum pixel width of the track end segments (if enabled with showTrackEnds).

Note : This is an advanced setting

Parameters:
trackEndWidth - trackEndWidth Default value is 12
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTrackEndWidth

public int getTrackEndWidth()
The minimum pixel width of the track end segments (if enabled with showTrackEnds).

Returns:
int

setTrackEndHeight

public void setTrackEndHeight(int trackEndHeight)
                       throws java.lang.IllegalStateException
The minimum pixel height of the track end segments (if enabled with showTrackEnds).

Note : This is an advanced setting

Parameters:
trackEndHeight - trackEndHeight Default value is 12
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTrackEndHeight

public int getTrackEndHeight()
The minimum pixel height of the track end segments (if enabled with showTrackEnds).

Returns:
int

setThumbOverlap

public void setThumbOverlap(int thumbOverlap)
                     throws java.lang.IllegalStateException
Number of pixels the thumb is allowed to overlap the buttons at each end of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Note : This is an advanced setting

Parameters:
thumbOverlap - thumbOverlap Default value is 1
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getThumbOverlap

public int getThumbOverlap()
Number of pixels the thumb is allowed to overlap the buttons at each end of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Returns:
int

setStartThumbOverlap

public void setStartThumbOverlap(java.lang.Integer startThumbOverlap)
                          throws java.lang.IllegalStateException
Number of pixels the thumb is allowed to overlap the buttons at the start of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Note : This is an advanced setting

Parameters:
startThumbOverlap - startThumbOverlap Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getStartThumbOverlap

public java.lang.Integer getStartThumbOverlap()
Number of pixels the thumb is allowed to overlap the buttons at the start of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Returns:
Integer

setEndThumbOverlap

public void setEndThumbOverlap(java.lang.Integer endThumbOverlap)
                        throws java.lang.IllegalStateException
Number of pixels the thumb is allowed to overlap the buttons at the end of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Note : This is an advanced setting

Parameters:
endThumbOverlap - endThumbOverlap Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEndThumbOverlap

public java.lang.Integer getEndThumbOverlap()
Number of pixels the thumb is allowed to overlap the buttons at the end of the track. Default prevents doubling of 1px borders. Set higher to allow media that shows curved joins between the track button and ScrollThumb.

Returns:
Integer

setThumbInset

public void setThumbInset(java.lang.Integer thumbInset)
                   throws java.lang.IllegalStateException
Inset of the thumb relative to the track. An inset of N pixels means the thumb is 2N pixels smaller in breadth than the track.

Note : This is an advanced setting

Parameters:
thumbInset - thumbInset Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getThumbInset

public java.lang.Integer getThumbInset()
Inset of the thumb relative to the track. An inset of N pixels means the thumb is 2N pixels smaller in breadth than the track.

Returns:
Integer

setSkinImgDir

public void setSkinImgDir(java.lang.String skinImgDir)
                   throws java.lang.IllegalStateException
Where are the skin images for the Scrollbar. This is local to the Page.getSkinDir().

Note : This is an advanced setting

Overrides:
setSkinImgDir in class Canvas
Parameters:
skinImgDir - skinImgDir Default value is "images/Scrollbar/"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getSkinImgDir

public java.lang.String getSkinImgDir()
Where are the skin images for the Scrollbar. This is local to the Page.getSkinDir().

Overrides:
getSkinImgDir in class Canvas
Returns:
String

setCornerSrc

public void setCornerSrc(java.lang.String cornerSrc)
                  throws java.lang.IllegalStateException
URL for the corner image, a singular image that appears in the corner when both h and v scrollbars are showing.

Parameters:
cornerSrc - cornerSrc Default value is "[SKIN]corner.gif"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCornerSrc

public java.lang.String getCornerSrc()
URL for the corner image, a singular image that appears in the corner when both h and v scrollbars are showing.

Returns:
String

setCornerSize

public void setCornerSize(java.lang.Integer cornerSize)
                   throws java.lang.IllegalStateException
Allows the size of the corner segment to be set independently of the btnSize.

Parameters:
cornerSize - cornerSize Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCornerSize

public java.lang.Integer getCornerSize()
Allows the size of the corner segment to be set independently of the btnSize.

Returns:
Integer

setHSrc

public void setHSrc(java.lang.String hSrc)
             throws java.lang.IllegalStateException
Base URL for the images used for the horizontal scrollbar track and end buttons.

See items for a general explanation of how this base URL is transformed into various pieces and states.

For a normal 3-segment track, the suffixes "_start", "_track" and "_end" are added to this URL. The "start" and "end" images should appear to be buttons (the user can click on these segments to scroll slowly). The "track" segment provides a background for the space in which the thumb can be dragged, and can also be clicked on to scroll quickly.

For a 5-segment track (showTrackEnds:true), the suffixes are "_start", "_track_start", "_track", "_track_end" and "_end".

Overrides:
setHSrc in class StretchImg
Parameters:
hSrc - hSrc Default value is "[SKIN]hscroll.gif"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getHSrc

public java.lang.String getHSrc()
Base URL for the images used for the horizontal scrollbar track and end buttons.

See items for a general explanation of how this base URL is transformed into various pieces and states.

For a normal 3-segment track, the suffixes "_start", "_track" and "_end" are added to this URL. The "start" and "end" images should appear to be buttons (the user can click on these segments to scroll slowly). The "track" segment provides a background for the space in which the thumb can be dragged, and can also be clicked on to scroll quickly.

For a 5-segment track (showTrackEnds:true), the suffixes are "_start", "_track_start", "_track", "_track_end" and "_end".

Overrides:
getHSrc in class StretchImg
Returns:
String

setVSrc

public void setVSrc(java.lang.String vSrc)
             throws java.lang.IllegalStateException
Base URL for the images used for the vertical scrollbar track and end buttons. See hSrc for usage.

Overrides:
setVSrc in class StretchImg
Parameters:
vSrc - vSrc Default value is "[SKIN]vscroll.gif"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getVSrc

public java.lang.String getVSrc()
Base URL for the images used for the vertical scrollbar track and end buttons. See hSrc for usage.

Overrides:
getVSrc in class StretchImg
Returns:
String