Package swingtree

Class UIForScrollPane<P extends JScrollPane>

java.lang.Object

swingtree.UIForAnything<UIForScrollPane<P>,P,JComponent>

swingtree.UIForAnySwing<UIForScrollPane<P>,P>

swingtree.UIForAnyScrollPane<UIForScrollPane<P>,P>

swingtree.UIForScrollPane<P>

public final class UIForScrollPane<P extends JScrollPane>
extends UIForAnyScrollPane<UIForScrollPane<P>,P>

A SwingTree builder node designed for configuring JScrollPane instances.
Use UIFactoryMethods.scrollPane() or UIFactoryMethods.scrollPane(Configurator) to create a new instance of this builder type.

Method Summary

Modifier and Type	Method	Description
protected void	_addComponentTo(P thisComponent, JComponent addedComponent, @Nullable AddConstraint constraints)	We override this method to wrap the added component in a UIForScrollPane.ScrollableBox instance in case a Configurator for ScrollableComponentDelegate instances was provided.
protected UIForScrollPane<P>	_newBuilderWithState(swingtree.BuilderState<P> newState)	An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.
protected swingtree.BuilderState<P>	_state()	Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.

Methods inherited from class swingtree.UIForAnyScrollPane

withBlockScrollIncrement, withHorizontalBlockScrollIncrement, withHorizontalScrollBarPolicy, withHorizontalScrollBarPolicy, withHorizontalScrollIncrement, withScrollBarPolicy, withScrollIncrement, withVerticalBlockScrollIncrement, withVerticalScrollBarPolicy, withVerticalScrollBarPolicy, withVerticalScrollIncrement

Methods inherited from class swingtree.UIForAnySwing

_addViewableProps, _addViewableProps, _isUndefinedColor, _isUndefinedFont, _setBackground, _setEnabled, _setMinHeight, _setMinWidth, _setPrefWidth, add, add, add, add, add, add, add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll, doUpdates, group, group, id, id, isEnabledIf, isEnabledIf, isEnabledIf, isEnabledIfNot, isEnabledIfNot, isEnabledIfNot, isFocusableIf, isFocusableIf, isFocusableIf, isFocusableIfNot, isFocusableIfNot, isFocusableIfNot, isValidIf, isVisibleIf, isVisibleIf, isVisibleIf, isVisibleIfNot, isVisibleIfNot, isVisibleIfNot, makeFocused, makeNonOpaque, makeOpaque, on, on, onCharTyped, onFocusGain, onFocusLoss, onHidden, onKeyPress, onKeyRelease, onKeyTyped, onMouseClick, onMouseDrag, onMouseEnter, onMouseEnter, onMouseEnterGreedy, onMouseExit, onMouseExit, onMouseExitGreedy, onMouseMove, onMousePress, onMouseRelease, onMouseWheelDown, onMouseWheelMove, onMouseWheelUp, onMoved, onPressed, onRelease, onResize, onShown, onTyped, onTyped, onView, withBackground, withBackground, withBackgroundColor, withBackgroundIf, withBackgroundIf, withBackgroundIf, withBackgroundIf, withBorder, withBorder, withBorderTitled, withBorderTitled, withBoxLayout, withCompoundBorder, withCompoundBorderTitled, withCursor, withCursor, withCursorIf, withCursorIf, withDragAway, withDropSite, withEmptyBorder, withEmptyBorder, withEmptyBorder, withEmptyBorder, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withFlowLayout, withFlowLayout, withFlowLayout, withForeground, withForeground, withForegroundColor, withForegroundIf, withForegroundIf, withForegroundIf, withForegroundIf, withGridBagLayout, withGridLayout, withGridLayout, withGridLayout, withHeight, withHeight, withHeightExactly, withHeightExactly, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLineBorder, withLineBorder, withLineBorder, withLineBorderTitled, withLineBorderTitled, withLineBorderTitled, withLineBorderTitled, withMatteBorder, withMatteBorder, withMatteBorder, withMatteBorderTitled, withMatteBorderTitled, withMatteBorderTitled, withMaxHeight, withMaxHeight, withMaxSize, withMaxSize, withMaxSize, withMaxSize, withMaxSize, withMaxWidth, withMaxWidth, withMinHeight, withMinHeight, withMinSize, withMinSize, withMinSize, withMinSize, withMinSize, withMinWidth, withMinWidth, withPrefHeight, withPrefHeight, withPrefSize, withPrefSize, withPrefSize, withPrefSize, withPrefSize, withPrefWidth, withPrefWidth, withProperty, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withSize, withSize, withSize, withSize, withSizeExactly, withSizeExactly, withSizeExactly, withSizeExactly, withStyle, withTooltip, withTooltip, withTransitionalStyle, withTransitoryStyle, withWidth, withWidth, withWidthExactly, withWidthExactly

Methods inherited from class swingtree.UIForAnything

_addBuildersTo, _addBuilderTo, _addComponentsTo, _disposeState, _onShow, _onShow, _runInApp, _runInApp, _runInUI, _this, _with, _withOnShow, _withOnShow, add, add, add, add, apply, applyIf, applyIfPresent, component, equals, get, getComponent, getType, hashCode, peek, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

_state

protected swingtree.BuilderState<P> _state()

Description copied from class: UIForAnything

Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.

Specified by:

_state in class UIForAnything<UIForScrollPane<P extends JScrollPane>,P extends JScrollPane,JComponent>

Returns:

The state of the builder.

_newBuilderWithState

protected UIForScrollPane<P> _newBuilderWithState(swingtree.BuilderState<P> newState)

Description copied from class: UIForAnything

An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.

Specified by:

_newBuilderWithState in class UIForAnything<UIForScrollPane<P extends JScrollPane>,P extends JScrollPane,JComponent>

Parameters:

newState - The new state which should be stored inside the new builder instance.

Returns:

A new builder instance with the provided state stored inside it.

_addComponentTo

protected void _addComponentTo(P thisComponent,
 JComponent addedComponent,
 @Nullable AddConstraint constraints)

We override this method to wrap the added component in a UIForScrollPane.ScrollableBox instance in case a Configurator for ScrollableComponentDelegate instances was provided. We then use the continuously supplied ScrollableComponentDelegate objects to satisfy the needs of the Scrollable implementation of the UIForScrollPane.ScrollableBox.
This way the user can take advantage of the Scrollable interface without the need for a custom implementation

Overrides:

_addComponentTo in class UIForAnyScrollPane<UIForScrollPane<P extends JScrollPane>,P extends JScrollPane>

Parameters:

thisComponent - The component which is wrapped by this builder.

addedComponent - A component instance which ought to be added to the wrapped component type.

constraints - The layout constraint which ought to be used to add the component to the wrapped component type.