|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.StatefulCanvas
com.smartgwt.client.widgets.StretchImg
com.smartgwt.client.widgets.Scrollbar
public class Scrollbar
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.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 |
---|
public Scrollbar()
public Scrollbar(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail |
---|
public static Scrollbar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected com.google.gwt.core.client.JavaScriptObject create()
create
in class StretchImg
public void setBtnSize(int btnSize)
btnSize
- btnSize Default value is 16public int getBtnSize()
public void setAutoEnable(java.lang.Boolean autoEnable)
Note : This is an advanced setting
autoEnable
- autoEnable Default value is truepublic java.lang.Boolean getAutoEnable()
public void setShowCorner(java.lang.Boolean showCorner) throws java.lang.IllegalStateException
Note : This is an advanced setting
showCorner
- showCorner Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowCorner()
public void setAllowThumbDownState(java.lang.Boolean allowThumbDownState) throws java.lang.IllegalStateException
Note : This is an advanced setting
allowThumbDownState
- allowThumbDownState Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowThumbDownState()
public void setAllowThumbOverState(java.lang.Boolean allowThumbOverState) throws java.lang.IllegalStateException
Note : This is an advanced setting
allowThumbOverState
- allowThumbOverState Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowThumbOverState()
public void setShowTrackEnds(java.lang.Boolean showTrackEnds) throws java.lang.IllegalStateException
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
showTrackEnds
- showTrackEnds Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowTrackEnds()
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).
public void setThumbMinSize(int thumbMinSize) throws java.lang.IllegalStateException
Note : This is an advanced setting
thumbMinSize
- thumbMinSize Default value is 12
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getThumbMinSize()
public void setTrackEndWidth(int trackEndWidth) throws java.lang.IllegalStateException
Note : This is an advanced setting
trackEndWidth
- trackEndWidth Default value is 12
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getTrackEndWidth()
public void setTrackEndHeight(int trackEndHeight) throws java.lang.IllegalStateException
Note : This is an advanced setting
trackEndHeight
- trackEndHeight Default value is 12
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getTrackEndHeight()
public void setThumbOverlap(int thumbOverlap) throws java.lang.IllegalStateException
Note : This is an advanced setting
thumbOverlap
- thumbOverlap Default value is 1
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getThumbOverlap()
public void setStartThumbOverlap(java.lang.Integer startThumbOverlap) throws java.lang.IllegalStateException
Note : This is an advanced setting
startThumbOverlap
- startThumbOverlap Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getStartThumbOverlap()
public void setEndThumbOverlap(java.lang.Integer endThumbOverlap) throws java.lang.IllegalStateException
Note : This is an advanced setting
endThumbOverlap
- endThumbOverlap Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getEndThumbOverlap()
public void setThumbInset(java.lang.Integer thumbInset) throws java.lang.IllegalStateException
Note : This is an advanced setting
thumbInset
- thumbInset Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getThumbInset()
public void setSkinImgDir(java.lang.String skinImgDir) throws java.lang.IllegalStateException
Page.getSkinDir()
.
Note : This is an advanced setting
setSkinImgDir
in class Canvas
skinImgDir
- skinImgDir Default value is "images/Scrollbar/"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSkinImgDir()
Page.getSkinDir()
.
getSkinImgDir
in class Canvas
public void setCornerSrc(java.lang.String cornerSrc) throws java.lang.IllegalStateException
cornerSrc
- cornerSrc Default value is "[SKIN]corner.gif"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getCornerSrc()
public void setCornerSize(java.lang.Integer cornerSize) throws java.lang.IllegalStateException
btnSize
.
cornerSize
- cornerSize Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getCornerSize()
btnSize
.
public void setHSrc(java.lang.String hSrc) throws java.lang.IllegalStateException
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".
setHSrc
in class StretchImg
hSrc
- hSrc Default value is "[SKIN]hscroll.gif"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getHSrc()
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".
getHSrc
in class StretchImg
public void setVSrc(java.lang.String vSrc) throws java.lang.IllegalStateException
hSrc
for usage.
setVSrc
in class StretchImg
vSrc
- vSrc Default value is "[SKIN]vscroll.gif"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getVSrc()
hSrc
for usage.
getVSrc
in class StretchImg
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |