com.jmex.bui
Class BScrollPane

java.lang.Object
  com.jmex.bui.BComponent
      com.jmex.bui.BContainer
          com.jmex.bui.BScrollPane

public class BScrollPane
extends BContainer

Provides a scrollable clipped view on a sub-heirarchy of components.

Nested Class Summary

protected static class

BScrollPane.BViewport Does all the heavy lifting for the BScrollPane.

Nested classes/interfaces inherited from class com.jmex.bui.BContainer

BContainer.ChildOp

Field Summary

protected BScrollBar	_hbar
protected boolean	_layingOut
protected boolean	_showAlways
protected BScrollBar	_vbar
protected BScrollPane.BViewport	_vport

Fields inherited from class com.jmex.bui.BContainer

_children, _layout

Fields inherited from class com.jmex.bui.BComponent

_alpha, _backgrounds, _bbuf, _borders, _colors, _cursor, _enabled, _height, _hover, _insets, _listeners, _parent, _preferredSize, _properties, _styleClass, _tipmouse, _tipStyle, _tiptext, _valid, _visible, _width, _x, _y, DEFAULT, DISABLED, HOVER, STATE_COUNT, STATE_PCLASSES

Constructor Summary

BScrollPane(BComponent child)

BScrollPane(BComponent child, boolean vert, boolean horiz)

BScrollPane(BComponent child, boolean vert, boolean horiz, int snap)

Method Summary

BComponent	getChild() Returns a reference to the child of this scroll pane.
BScrollBar	getHorizontalScrollBar() Returns a reference to the horizontal scroll bar.
BScrollBar	getVerticalScrollBar() Returns a reference to the vertical scroll bar.
void	layout() Instructs this component to lay itself out.
void	setShowScrollbarAlways(boolean showAlways) Toggles the scroll bar policy.
void	setViewportStyleClass(String styleClass) Configures the style class of the viewport (the non-scrolling container that will hold the scrolling contents).

Methods inherited from class com.jmex.bui.BContainer

add, add, add, add, applyOperation, computePreferredSize, getComponent, getComponentCount, getComponentIndex, getDefaultStyleClass, getHitComponent, getLayoutManager, getNextFocus, getPreviousFocus, remove, remove, removeAll, renderComponent, replace, setAlpha, setEnabled, setLayoutManager, setVisible, validate, wasAdded, wasRemoved

Methods inherited from class com.jmex.bui.BComponent

acceptsFocus, addListener, applyDefaultStates, boundsToString, changeCursor, configureStyle, createTooltipComponent, dispatchEvent, emitEvent, getAbsoluteX, getAbsoluteY, getAlpha, getBackground, getBorder, getBounds, getColor, getCursor, getFocusTarget, getHeight, getInsets, getNextFocus, getParent, getPreferredSize, getPreviousFocus, getProperty, getState, getStateCount, getStatePseudoClass, getStyleClass, getTooltipText, getWidth, getWindow, getX, getY, hasFocus, intersectScissorBox, invalidate, isAdded, isEnabled, isShowing, isTooltipRelativeToMouse, isValid, isVisible, removeAllListeners, removeListener, render, renderBackground, renderBorder, requestFocus, restoreScissorState, setBackground, setBounds, setCursor, setLocation, setParent, setPreferredSize, setPreferredSize, setProperty, setSize, setStyleClass, setTooltipRelativeToMouse, setTooltipText, stateDidChange, updateCursor

Methods inherited from class java.lang.Object

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

Field Detail

_vport

protected BScrollPane.BViewport _vport

_vbar

protected BScrollBar _vbar

_hbar

protected BScrollBar _hbar

_showAlways

protected boolean _showAlways

_layingOut

protected boolean _layingOut

Constructor Detail

BScrollPane

public BScrollPane(BComponent child)

BScrollPane

public BScrollPane(BComponent child,
                   boolean vert,
                   boolean horiz)

BScrollPane

public BScrollPane(BComponent child,
                   boolean vert,
                   boolean horiz,
                   int snap)

Method Detail

getChild

public BComponent getChild()

Returns a reference to the child of this scroll pane.

getVerticalScrollBar

public BScrollBar getVerticalScrollBar()

Returns a reference to the vertical scroll bar.

getHorizontalScrollBar

public BScrollBar getHorizontalScrollBar()

Returns a reference to the horizontal scroll bar.

setShowScrollbarAlways

public void setShowScrollbarAlways(boolean showAlways)

Toggles the scroll bar policy. If set to true, the bars will always show. If set to false, the bars will only show when needed.

setViewportStyleClass

public void setViewportStyleClass(String styleClass)

Configures the style class of the viewport (the non-scrolling container that will hold the scrolling contents).

layout

public void layout()

Description copied from class: BComponent

Instructs this component to lay itself out. This is called as a result of the component changing size.

Overrides:

layout in class BContainer