Package org.dwcj.controls.scrollbar

Class ScrollBar

java.lang.Object

org.dwcj.controls.AbstractControl

org.dwcj.controls.AbstractDwcControl

org.dwcj.controls.scrollbar.ScrollBar

All Implemented Interfaces:

Control, Enableable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasStyle, HasTooltip, HasVisibility

public final class ScrollBar
extends AbstractDwcControl

Field Summary

Fields inherited from class org.dwcj.controls.AbstractDwcControl

BASISNUMBER_1, BASISNUMBER_25, BASISNUMBER_250, focusable, horizontalScrollBarPosition, mouseWheelCondition, readOnly, STR_EXPANSE, STR_THEME, tabTraversable, textAlignment, textHighlight, verticalScrollBarPosition

Fields inherited from class org.dwcj.controls.AbstractControl

ctrl, destroyed, elementId, userData

Constructor Summary

Constructors

Constructor	Description
ScrollBar(boolean horizontal)

Method Summary

Modifier and Type	Method	Description
ScrollBar	addClassName(String selector)	Adds a CSS class to the list of CSS classes for the control.
protected void	catchUp()	The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation.
protected void	create(AbstractDwcjPanel p)	Create the object on a panel p.
int	getBlockIncrement()
int	getScrollMaximum()
int	getScrollMinimum()
int	getScrollPosition()
int	getScrollProp()
ScrollBar	onScroll(Consumer<ScrollbarMoveEvent> callback)
ScrollBar	removeClassName(String selector)	Removes a CSS class from the list of CSS classes for the control.
ScrollBar	setAttribute(String attribute, String value)	set the value for an attribute in the control
ScrollBar	setBlockIncrement(int block)
ScrollBar	setEnabled(Boolean enabled)	Set whether the control is to be enabled
ScrollBar	setId(String elementId)	Assigns the ID of a control
ScrollBar	setScrollPosition(int pos)
ScrollBar	setScrollProp(int prop)
ScrollBar	setScrollRange(int min, int max)
ScrollBar	setStyle(String property, String value)	Assigns specified value to the specified CSS property
ScrollBar	setText(String text)	set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all
ScrollBar	setTooltipText(String text)	Set the tooltip text of the control
ScrollBar	setVisible(Boolean visible)	Set whether the control is visible or invisible

Methods inherited from class org.dwcj.controls.AbstractDwcControl

destroy, getAttribute, getComputedStyle, getText, getTooltipText, isEnabled, isVisible, setControlExpanse, setControlTheme

Methods inherited from class org.dwcj.controls.AbstractControl

getCaughtUp, getId, getUserData, isDestroyed, setUserData

Methods inherited from class java.lang.Object

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

Constructor Details

ScrollBar

public ScrollBar(boolean horizontal)

Method Details

create

protected void create(AbstractDwcjPanel p)

Description copied from class: AbstractControl

Create the object on a panel p. The preferred way of creating an object is using the Panel::add(Control) method, instead of this

Overrides:

create in class AbstractControl

Parameters:

p - the panel to add this control on

onScroll

public ScrollBar onScroll(Consumer<ScrollbarMoveEvent> callback)

getBlockIncrement

public int getBlockIncrement()

getScrollMaximum

public int getScrollMaximum()

getScrollMinimum

public int getScrollMinimum()

getScrollPosition

public int getScrollPosition()

getScrollProp

public int getScrollProp()

setBlockIncrement

public ScrollBar setBlockIncrement(int block)

setScrollPosition

public ScrollBar setScrollPosition(int pos)

setScrollProp

public ScrollBar setScrollProp(int prop)

setScrollRange

public ScrollBar setScrollRange(int min,
 int max)

setText

public ScrollBar setText(String text)

Description copied from interface: HasControlText

set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all

Specified by:

setText in interface HasControlText

Overrides:

setText in class AbstractDwcControl

Returns:

the control itself

setVisible

public ScrollBar setVisible(Boolean visible)

Description copied from interface: HasVisibility

Set whether the control is visible or invisible

Specified by:

setVisible in interface HasVisibility

Overrides:

setVisible in class AbstractDwcControl

Returns:

the control itself

setEnabled

public ScrollBar setEnabled(Boolean enabled)

Description copied from interface: Enableable

Set whether the control is to be enabled

Specified by:

setEnabled in interface Enableable

Overrides:

setEnabled in class AbstractDwcControl

Returns:

the control itself

setTooltipText

public ScrollBar setTooltipText(String text)

Description copied from interface: HasTooltip

Set the tooltip text of the control

Specified by:

setTooltipText in interface HasTooltip

Overrides:

setTooltipText in class AbstractDwcControl

Returns:

the control itself

setAttribute

public ScrollBar setAttribute(String attribute,
 String value)

Description copied from class: AbstractDwcControl

set the value for an attribute in the control

Specified by:

setAttribute in interface HasAttribute

Overrides:

setAttribute in class AbstractDwcControl

Parameters:

attribute - the name of the attribute

value - the value to be set

Returns:

the control itself

setId

public ScrollBar setId(String elementId)

Description copied from interface: Control

Assigns the ID of a control

Specified by:

setId in interface Control

Overrides:

setId in class AbstractControl

Parameters:

elementId - Desired ID designation

Returns:

The control itself

setStyle

public ScrollBar setStyle(String property,
 String value)

Description copied from interface: HasStyle

Assigns specified value to the specified CSS property

Specified by:

setStyle in interface HasStyle

Overrides:

setStyle in class AbstractDwcControl

Parameters:

property - The CSS property to be changed

value - The value of the selected CSS property

Returns:

The control itself

addClassName

public ScrollBar addClassName(String selector)

Description copied from interface: HasClassName

Adds a CSS class to the list of CSS classes for the control.

Specified by:

addClassName in interface HasClassName

Overrides:

addClassName in class AbstractDwcControl

Returns:

The control itself

removeClassName

public ScrollBar removeClassName(String selector)

Description copied from interface: HasClassName

Removes a CSS class from the list of CSS classes for the control.

Specified by:

removeClassName in interface HasClassName

Overrides:

removeClassName in class AbstractDwcControl

Returns:

The control itself

catchUp

protected void catchUp()
                throws IllegalAccessException

Description copied from class: AbstractDwcControl

The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation. A control is not created before it's added to a panel. Anything that is added between instantiation of a control and its addition to a panel has to be recorded and replayed in this method

Overrides:

catchUp in class AbstractDwcControl

Throws:

IllegalAccessException - - thrown if an attempt is made to call this method more than once