javax.swing.JScrollBar — clojure-interop/javax.swing 1.0.5

An implementation of a scrollbar. The user positions the knob in the scrollbar to determine the contents of the viewing area. The program typically adjusts the display so that the end of the scrollbar represents the end of the displayable contents, or 100% of the contents. The start of the scrollbar is the beginning of the displayable contents, or 0%. The position of the knob within those bounds then translates to the corresponding percentage of the displayable contents.

Typically, as the position of the knob in the scrollbar changes a corresponding change is made to the position of the JViewport on the underlying view, changing the contents of the JViewport.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

->j-scroll-bar clj

(->j-scroll-bar)

(->j-scroll-bar orientation)

(->j-scroll-bar orientation value extent min max)

Constructor.

Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum. The "extent" is the size of the viewable area. It is also known as the "visible amount".

Note: Use setBlockIncrement to set the block increment to a size slightly smaller than the view's extent. That way, when the user jumps the knob to an adjacent position, one or two lines of the original contents remain in view.

orientation - int value - int extent - int min - int max - int

throws: java.lang.IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTAL

add-adjustment-listener clj

(add-adjustment-listener this l)

Adds an AdjustmentListener. Adjustment listeners are notified each time the scrollbar's model changes. Adjustment events are provided for backwards compatibility with java.awt.Scrollbar.

Note that the AdjustmentEvents type property will always have a placeholder value of AdjustmentEvent.TRACK because all changes to a BoundedRangeModels value are considered equivalent. To change the value of a BoundedRangeModel one just sets its value property, i.e. model.setValue(123). No information about the origin of the change, e.g. it's a block decrement, is provided. We don't try fabricate the origin of the change here.

l - the AdjustmentLister to add - java.awt.event.AdjustmentListener

get-accessible-context clj

(get-accessible-context this)

Gets the AccessibleContext associated with this JScrollBar. For JScrollBar, the AccessibleContext takes the form of an AccessibleJScrollBar. A new AccessibleJScrollBar instance is created if necessary.

returns: an AccessibleJScrollBar that serves as the AccessibleContext of this JScrollBar - javax.accessibility.AccessibleContext

get-adjustment-listeners clj

(get-adjustment-listeners this)

Returns an array of all the AdjustmentListeners added to this JScrollBar with addAdjustmentListener().

returns: all of the AdjustmentListeners added or an empty array if no listeners have been added - java.awt.event.AdjustmentListener[]

get-block-increment clj

(get-block-increment this)

(get-block-increment this direction)

Returns the amount to change the scrollbar's value by, given a block (usually "page") up/down request. A ScrollBarUI implementation typically calls this method when the user clicks above or below the scrollbar "knob" to change the value up or down by large amount. Subclasses my override this method to compute a value, e.g. the change required to scroll up or down one paragraph in a text document.

The JScrollPane component creates scrollbars (by default) that override this method and delegate to the viewports Scrollable view, if it has one. The Scrollable interface provides a more specialized version of this method.

Some look and feels implement custom scrolling behavior and ignore this property.

direction - is -1 or 1 for up/down respectively - int

returns: the value of the blockIncrement property - int

get-maximum clj

(get-maximum this)

The maximum value of the scrollbar is maximum - extent.

returns: the value of the model's maximum property - int

get-maximum-size clj

(get-maximum-size this)

The scrollbar is flexible along it's scrolling axis and rigid along the other axis.

returns: the value of the maximumSize property - java.awt.Dimension

get-minimum clj

(get-minimum this)

Returns the minimum value supported by the scrollbar (usually zero).

returns: the value of the model's minimum property - int

get-minimum-size clj

(get-minimum-size this)

The scrollbar is flexible along it's scrolling axis and rigid along the other axis.

returns: the value of the minimumSize property - java.awt.Dimension

get-model clj

(get-model this)

Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

returns: javax.swing.BoundedRangeModel

get-orientation clj

(get-orientation this)

Returns the component's orientation (horizontal or vertical).

returns: VERTICAL or HORIZONTAL - int

get-ui clj

(get-ui this)

Returns the delegate that implements the look and feel for this component.

returns: javax.swing.plaf.ScrollBarUI

get-ui-class-id clj

(get-ui-class-id this)

Returns the name of the LookAndFeel class for this component.

returns: "ScrollBarUI" - java.lang.String

get-unit-increment clj

(get-unit-increment this)

(get-unit-increment this direction)

Returns the amount to change the scrollbar's value by, given a unit up/down request. A ScrollBarUI implementation typically calls this method when the user clicks on a scrollbar up/down arrow and uses the result to update the scrollbar's value. Subclasses my override this method to compute a value, e.g. the change required to scroll up or down one (variable height) line text or one row in a table.

The JScrollPane component creates scrollbars (by default) that override this method and delegate to the viewports Scrollable view, if it has one. The Scrollable interface provides a more specialized version of this method.

Some look and feels implement custom scrolling behavior and ignore this property.

direction - is -1 or 1 for up/down respectively - int

returns: the value of the unitIncrement property - int

get-value clj

(get-value this)

Returns the scrollbar's value.

returns: the model's value property - int

get-value-is-adjusting? clj

(get-value-is-adjusting? this)

True if the scrollbar knob is being dragged.

returns: the value of the model's valueIsAdjusting property - boolean

get-visible-amount clj

(get-visible-amount this)

Returns the scrollbar's extent, aka its "visibleAmount". In many scrollbar look and feel implementations the size of the scrollbar "knob" or "thumb" is proportional to the extent.

returns: the value of the model's extent property - int

remove-adjustment-listener clj

(remove-adjustment-listener this l)

Removes an AdjustmentEvent listener.

l - the AdjustmentLister to remove - java.awt.event.AdjustmentListener

set-block-increment clj

(set-block-increment this block-increment)

Sets the blockIncrement property.

Note, that if the argument is equal to the value of Integer.MIN_VALUE, the most look and feels will not provide the scrolling to the right/down.

Some look and feels implement custom scrolling behavior and ignore this property.

block-increment - the block increment - int

set-enabled clj

(set-enabled this x)

Enables the component so that the knob position can be changed. When the disabled, the knob position cannot be changed.

x - a boolean value, where true enables the component and false disables it - boolean

set-maximum clj

(set-maximum this maximum)

Sets the model's maximum property. Note that the scrollbar's value can only be set to maximum - extent.

maximum - the maximum value - int

set-minimum clj

(set-minimum this minimum)

Sets the model's minimum property.

minimum - the minimum value - int

set-model clj

(set-model this new-model)

Sets the model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

new-model - javax.swing.BoundedRangeModel

set-orientation clj

(set-orientation this orientation)

Set the scrollbar's orientation to either VERTICAL or HORIZONTAL.

orientation - int

throws: java.lang.IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTAL

set-ui clj

(set-ui this ui)

Sets the L&F object that renders this component.

ui - the ScrollBarUI L&F object - javax.swing.plaf.ScrollBarUI

set-unit-increment clj

(set-unit-increment this unit-increment)

Sets the unitIncrement property.

Note, that if the argument is equal to the value of Integer.MIN_VALUE, the most look and feels will not provide the scrolling to the right/down.

Some look and feels implement custom scrolling behavior and ignore this property.

unit-increment - the unit increment - int

set-value clj

(set-value this value)

Sets the scrollbar's value. This method just forwards the value to the model.

value - the current value, between minimum and maximum - visibleAmount - int

set-value-is-adjusting clj

(set-value-is-adjusting this b)

Sets the model's valueIsAdjusting property. Scrollbar look and feel implementations should set this property to true when a knob drag begins, and to false when the drag ends. The scrollbar model will not generate ChangeEvents while valueIsAdjusting is true.

b - boolean

set-values clj

(set-values this new-value new-extent new-min new-max)

Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints:

minimum ≤ value ≤ value+extent ≤ maximum

new-value - int new-extent - int new-min - int new-max - int

set-visible-amount clj

(set-visible-amount this extent)

Set the model's extent property.

extent - the length of the indicator - int

update-ui clj

(update-ui this)

Overrides JComponent.updateUI.