eve.ui

Class ScrollBarPanel

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.Container

eve.ui.Canvas

eve.ui.Panel

eve.ui.CellPanel

eve.ui.ScrollablePanel

eve.ui.ScrollBarPanel

All Implemented Interfaces:

Drawable, ImageRefresher, DataInterface, TimerProc, CellConstants, ControlConstants, HasAncestor, IScroll, LayoutManager, ScrollClient, ScrollServer, UIConstants, EventListener

Direct Known Subclasses:

HorizontalScrollPanel, VerticalScrollPanel

public class ScrollBarPanel
extends ScrollablePanel

Field Summary

Fields

Modifier and Type	Field and Description
ScrollBar	hbar The horizontal scroll bar.
static int	OPTION_EXTRA_CONTROLS_AFTER_HORIZONTAL_BAR
static int	OPTION_EXTRA_CONTROLS_AFTER_VERTICAL_BAR
static int	OPTION_EXTRA_CONTROLS_BEFORE_HORIZONTAL_BAR
static int	OPTION_EXTRA_CONTROLS_BEFORE_VERTICAL_BAR
ScrollBar	vbar The vertical scroll bar.

Fields inherited from class eve.ui.ScrollablePanel

alwaysShow, AlwaysShowHorizontalScrollers, AlwaysShowVerticalScrollers, blockUpdate, client, hscrollerChanges, neverShow, NeverShowHorizontalScrollers, NeverShowVerticalScrollers, options, Permanent, vanish, vscrollerChanges

Fields inherited from class eve.ui.CellPanel

autoSpan, layout, mySplitter, nextSplitter, quickRecalculate

Fields inherited from class eve.ui.Panel

all, calculated, childListeners, defaultAddToMeCellConstraints, defaultTags, equalHeights, equalWidths, grid, lastAdded, layoutManager, made, noInsets, stretchFirstColumn, stretchFirstRow, stretchLastColumn, stretchLastRow, titleGap

Fields inherited from class eve.ui.Canvas

isFullScrollClient, origin, scrollPercent, virtualSize

Fields inherited from class eve.ui.Container

closedFocus, cycleFocus, dontAutoScroll, dontFocusOnChildren, FIND_FOR_MOUSE_PRESS, takeNextFocus

Fields inherited from class eve.ui.Control

backGround, beforeRemoved, borderColor, borderStyle, borderWidth, children, columns, constraints, curFont, debugModify, debugRepaintNow, disabledBackground, dragging, dragResolution, dragTime, exitKeys, fieldTransfer, font, fontChange, fontFrom, foreGround, height, holdDownPause, holdTick, hotKey, image, lastSelected, listeners, lockPaint, maxHeight, maxWidth, menuState, minHeight, minWidth, modifiers, name, next, parent, penStatus, preferredHeight, preferredWidth, prev, prompt, promptControl, rows, ss, startDragResolution, tags, tail, text, toolTip, width, x, y

Fields inherited from class eve.ui.ControlBase

clipItems, clipObject, clipOwner, debugControl, debugFlag, doubleBuffer, doubleClickTime, doubleSizedFontHeight, firstPress, globalEditable, globalEnabled, PEN_STATUS_DID_HOLD_DOWN, PEN_STATUS_GOT_PEN_DOWN, PEN_STATUS_PEN_IS_ON, pressPoint, TAG_BOOLEAN_KEEP_BELOW_SIP, TAG_HOVER_TIME_INT, TAG_LAST_USER_DATA, TAG_USER_DATA, TAKE_FIRST_PRESS, unnamed

Fields inherited from interface eve.ui.IScroll

GoHigher, GoLower, Horizontal, OPTION_INDICATOR_ONLY, PageHigher, PageLower, ScrollHigher, ScrollLower, TrackTo, Vertical

Fields inherited from interface eve.ui.CellConstants

ALWAYS_STRETCHABLE, BOTTOM, CELLFLAG, CELLMASK, CENTER, CONTROLMASK, DONTCHANGE, DONTFILL, DONTSTRETCH, EAST, FILL, GROW, HCENTER, HCONTRACT, HEXPAND, HFILL, HGROW, HSHRINK, HSTRETCH, INITIALLY_CLOSED, INITIALLY_HIDDEN, INITIALLY_MINIMIZED, INITIALLY_PREFERRED_SIZE, INSETS, LEFT, MAXIMUMSIZE, MINIMUMSIZE, NORTH, NORTHEAST, NORTHWEST, PREFERREDSIZE, RECT, RIGHT, SHRINK, SOUTH, SOUTHEAST, SOUTHWEST, SPAN, STRETCH, TAG_BACKGROUND_IMAGE, TAG_BUSY_DISPLAY, TAG_COLORS, TAG_CONTROL_PAINTER, TAG_EXPOSE_GROUP, TAG_FIXEDSIZE, TAG_GRAY_BACKGROUND, TAG_HIDE_CONTROL_OBJECT, TAG_HIDE_PARENT, TAG_INNER_TEXT_INSETS, TAG_INPUT_STACK_PARENT, TAG_INSETS, TAG_MAKE_VISIBLE, TAG_MAXIMUMSIZE, TAG_MINIMUMSIZE, TAG_PAINT_CONTROL_LIST, TAG_PREFERRED_TEXT_SIZE, TAG_PREFERRED_TEXT_SIZE_HEIGHT, TAG_PREFERRED_TEXT_SIZE_WIDTH, TAG_PREFERREDSIZE, TAG_RECT, TAG_SHADOW_INSETS, TAG_SPAN, TAG_SWIPER, TAG_TEMPORARY_ERROR, TAG_TEXT_INSETS, TAG_TEXTSIZE, TEXTSIZE, TOP, VCENTER, VCONTRACT, VEXPAND, VFILL, VGROW, VSHRINK, VSTRETCH, WEST

Fields inherited from interface eve.ui.UIConstants

BDR_DOTTED, BDR_INNER, BDR_NOBORDER, BDR_OUTER, BDR_OUTLINE, BDR_RAISEDINNER, BDR_RAISEDOUTER, BDR_SUNKENINNER, BDR_SUNKENOUTER, BF_ABUT_ANY, BF_ABUT_BOTTOM, BF_ABUT_LEFT, BF_ABUT_RIGHT, BF_ABUT_TOP, BF_BOTTOM, BF_BOTTOMLEFT, BF_BOTTOMRIGHT, BF_BUTTON, BF_DIAGONAL, BF_DIAGONAL_ENDBOTTOMLEFT, BF_DIAGONAL_ENDBOTTOMRIGHT, BF_DIAGONAL_ENDTOPLEFT, BF_DIAGONAL_ENDTOPRIGHT, BF_EXACT, BF_FLAT, BF_LEFT, BF_MIDDLE, BF_MONO, BF_PALM, BF_RECT, BF_RIGHT, BF_SOFT, BF_SQUARE, BF_TOP, BF_TOPLEFT, BF_TOPRIGHT, EDGE_BUMP, EDGE_ETCHED, EDGE_RAISED, EDGE_SUNKEN

Fields inherited from interface eve.ui.ControlConstants

All, AlwaysEnabled, AlwaysRecalculateSizes, ByDeferredMouse, ByDeferredPen, ByFrameChange, ByKeyboard, ByMouse, ByPen, ByRequest, CalculatedSizes, ContainerDontPaintChildren, Disabled, DisablePopupMenu, DisplayOnly, DontBuffer, Down, DrawFlat, Flag, ForceResize, HasData, Invisible, KeepImage, KeepSIP, Left, MakeMenuAtLeastAsWide, Maximize, Minimize, ModifiersInheritedFromWindow, MouseSensitive, NoFocus, NotAnEditor, NotEditable, PaintDataOnly, PaintOutsideOnly, PenTransparent, PreferredSizeOnly, Right, SendUpUIEvents, ShowSIP, ShrinkToNothing, SmallControl, TakeChildUIEvents, TakeControlEvents, TakesKeyFocus, Transparent, Up, WantDrag, WantHoldDown

Fields inherited from interface eve.fx.ImageRefresher

KEEP_VISIBLE

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
ScrollBarPanel(ScrollClient client) Create a new ScrollBarPanel for the specified client and with the specified options.
ScrollBarPanel(ScrollClient client, int options) Create a new ScrollBarPanel for the specified client.

Method Summary

Modifier and Type	Method and Description
void	checkScrolls(int width, int height, boolean reDraw)
void	dismantle(Control downTo)
CellPanel	getExtraPanel(int optionExtraControl) Return the extra panel created if any of the OPTION_EXTRA_CONTROLS_XXX options are specified.
void	modifyScrollers(int set, int clear)
void	onEvent(Event ev)
void	onScrollEvent(ScrollEvent se)
void	setExtraPanelSpacing(int pixelSpace) Set the spacing between the any added extra controls and the scroll bar it is next to.
void	setExtraPanelSpacing(int optionExtraControl, int pixelSpace) Set the spacing between the specified extra controls and the scroll bar it is next to.
ScrollBarPanel	setHorizontalPainter(PaintControl pc)
void	setOptions(int options) Set options for the ScrollablePanel.
void	setScroll(int which, int v, int a, int c)
void	setScrollBarSize(int buttonWidth, int buttonHeight, int minThumb) Set the sizes for the scroll bar buttons and thumb bar.
ScrollBarPanel	setVerticalPainter(PaintControl pc)
void	updateScroll(int which) This method tells the ScrollServer to update a particular scrolling control.

Methods inherited from class eve.ui.ScrollablePanel

changeContents, checkScrolls, getClient, getClientConstraints, make, redisplay, reset, resizeTo, setClientConstraints, setClientConstraints

Methods inherited from class eve.ui.CellPanel

calculateSizes, getFloatingControls, getSubControls, hasFloatingControls, makeLayoutGrid, relayoutMe, removeAll, reShow, resize

Methods inherited from class eve.ui.Panel

add, addChildListener, addDirectly, addLast, addLast, addLast, addNext, addNext, addNext, addNext, calculatedSizes, doBorder, endRow, getControlTag, getPreferredSize, insertRow, isEmpty, layout, remove, removeChildListener, sendToChildListeners, setAsBelowSip, setText

Methods inherited from class eve.ui.Canvas

canGo, canScreenScroll, doScroll, fixOrigin, getActual, getBuffer, getCurrent, getDisplayedSize, getMyHeight, getMySize, getMyWidth, getPercent, getScrollablePanel, getScrollClient, getVisible, getVisibleArea, needScrollBar, onScroll, onSetOrigin, reduceClip, scroll, scroll, scrollToVisible, setOrigin, updateScrollServer

Methods inherited from class eve.ui.Container

add, completeAddPopupControl, containerHasFocus, dismantle, doHotKey, doPaint, findChild, findChild, focusFirst, focusFirst, focusOnContainer, focusOnData, getChildren, getFirstFocus, getNextKeyFocus, gotFocus, grayOut, hide, lostFocus, relayout, removePopupControl, repaintDataNow, setHidden, startAddPopupControl, takeFocus, takePromptControl, unhide

Methods inherited from class eve.ui.Control

acceptsData, activate, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculateTextSize, calculateTextSize, calculateTextSize, cancelHoldDown, cancelPenPress, canEdit, change, changeDimension, changeTag, checkClipboardOperations, checkExitKey, checkMenu, checkMenuKey, checkModifiers, checkParentInterceptsUIEvent, checkPenTransparent, childrenPainted, clearTag, clipboardToString, clipboardTransfer, closeMenu, contains, contains, createNewMenu, dataAccepted, dataBeingRemoved, dataDraggedOff, dataDraggedOver, dataDraggedOver, dataDroppedOn, dataTransferCancelled, deactivate, defaultTo, deferInWindowThread, doAction, doActionKey, doBackground, doMenu, dontAcceptDrop, doPaintChildren, doPaintData, doPaintData, doShowMenu, dragged, draw, draw, draw, exitEntry, fillBackground, fillBackgroundNotInFrame, findTagInParents, fontChanged, formClosing, free, fromClipboard, fromField, fromField, getAllDescendants, getAllSubControls, getAncestor, getAncestor, getAncestorProperty, getBackground, getCached, getCachedChildren, getCachedDim, getCachedDim, getCachedRect, getCachedRect, getCachedSubControls, getChildAnchor, getChildren, getChildrenBackwards, getClipboardMenu, getClipObject, getContentsInsets, getContentsInsets, getContentsRect, getDataToCopy, getDataToDragAndDrop, getDim, getDisplayText, getDragAndDropContext, getFieldTransfer, getFont, getFontMetrics, getFontMetrics, getFontMetricsForSizeCalculations, getForeground, getFrame, getFrameOrContainer, getGraphics, getGraphics, getHeight, getHideParent, getImage, getLastSelected, getLocation, getLock, getMaximumSize, getMenu, getMinimumSize, getModifiedBorderFlags, getModifiers, getNext, getPaintParameters, getParent, getParent, getParent, getParentOrListener, getPasswordCharacter, getPosInFrame, getPosInFrame, getPosInParent, getPosInParent, getPreferredSize, getPreferredSizeByParent, getPreferredTextSize, getPrompt, getPromptText, getRect, getRect, getServer, getSize, getSizes, getSubControls, getTag, getText, getToolTip, getWidth, getWindow, getWindowGraphics, hasModifier, hasPopupFormAttached, hasTag, hide, inheritModifiers, insetToContents, interceptChildUIEvent, isChildOf, isDirectChildOfWindow, isHidden, isModal, isOnMe, isOnMe, isOnMe, isSomeonesHotKey, makeFrameTopMost, makeHot, makeHot, makeInvisible, makeVisible, markAsTemporaryError, menuIsActive, menuStateChanged, modify, modifyAll, modifyAll, modifyFlags, mouseHover, newEventThread, notifyAction, notifyDataChange, notifyDataChange, notifyMenuItemSelected, notifyStructureChanged, onControlEvent, onKeyEvent, onLabelPenEvent, onPenEvent, paintBackground, paintWithControlPainter, pauseEventThread, penClicked, penDoubleClicked, penHeld, penPressed, penReleased, penRightReleased, popupBeep, popupMenuClosed, popupMenuEvent, popupMenuEvent, postEvent, postInWindowThread, postUIEvent, putInside, queueKeyEvent, queuePenEvent, readLock, recalculatePreferredSize, refresh, releaseBufferedGraphics, removed, removeListener, repaint, repaint, repaintInWindowThread, repaintInWindowThread, repaintNow, repaintNow, repaintNow, repaintNow, requestPaint, requestResizeTo, resetAllCachedProperties, resetCachedProperties, resetRect, restore, restoreBorderModifiers, restoreFlags, resumeEventThread, scrollAndRepaint, sendToListeners, set, setAllFonts, setBackgroundImage, setBorder, setBorderModifiers, setCell, setChildAnchor, setClipObject, setControl, setCursor, setFieldTransfer, setFixedSize, setFont, setFontChange, setFreeDragging, setHidden, setHiddenParent, setHotKey, setHotKey, setLocation, setMaximumSize, setMenu, setMinimumSize, setPreferredSize, setPreferredTextSize, setPreferredTextSize, setPromptControl, setRect, setRect, setScaledBackgroundImage, setServer, setShadow, setSwiping, setTag, setTags, setTextSize, setTiledBackgroundImage, setToolTip, showHoldDownIndicator, shown, simulateClickOn, simulateKeyPresses, simulateKeyType, standardOnKeyEvent, startDragAndDrop, startDragAndDrop, startDragging, stopDragging, takeData, takeFromClipboard, testInWindowThread, ticked, tipIsDisplayed, toClipboard, toField, toField, toIDString, toString, toTextData, transferPenPress, transferPenPress, tryDragAndDrop, tryGetGraphics, tryNext, tryStartMenu, unhide, unlock, updateData, updateDCDuringDD, updateFrom, updateTo, verifyWantDrag, verifyWantHoldDown, waitEventThread, willAcceptDrop, willShowFrame, windowHasFloatingControls, writeLock

Methods inherited from class eve.ui.ControlBase

doubleSizeIt, getGuiTextHeight, isDoubleSized, isDoubleSizedFont, loadImage, tryLoadImage

Methods inherited from class java.lang.Object

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

Methods inherited from interface eve.ui.ScrollClient

getServer, setServer

Field Detail

hbar

public ScrollBar hbar

The horizontal scroll bar. This is ALWAYS present even if the scrollbar is not displayed on the screen.

vbar

public ScrollBar vbar

The vertical scroll bar. This is ALWAYS present even if the scrollbar is not displayed on the screen.

OPTION_EXTRA_CONTROLS_BEFORE_HORIZONTAL_BAR

public static final int OPTION_EXTRA_CONTROLS_BEFORE_HORIZONTAL_BAR

See Also:

Constant Field Values

OPTION_EXTRA_CONTROLS_AFTER_HORIZONTAL_BAR

public static final int OPTION_EXTRA_CONTROLS_AFTER_HORIZONTAL_BAR

See Also:

Constant Field Values

OPTION_EXTRA_CONTROLS_BEFORE_VERTICAL_BAR

public static final int OPTION_EXTRA_CONTROLS_BEFORE_VERTICAL_BAR

See Also:

Constant Field Values

OPTION_EXTRA_CONTROLS_AFTER_VERTICAL_BAR

public static final int OPTION_EXTRA_CONTROLS_AFTER_VERTICAL_BAR

See Also:

Constant Field Values

Constructor Detail

ScrollBarPanel

public ScrollBarPanel(ScrollClient client,
                      int options)

Create a new ScrollBarPanel for the specified client.

ScrollBarPanel

public ScrollBarPanel(ScrollClient client)

Create a new ScrollBarPanel for the specified client and with the specified options.

Method Detail

setScrollBarSize

public void setScrollBarSize(int buttonWidth,
                             int buttonHeight,
                             int minThumb)

Set the sizes for the scroll bar buttons and thumb bar.

Parameters:

buttonWidth - the preferred button width.

buttonHeight - the preferred button height.

minThumb - the preferred minimum thumb bar thickness.

getExtraPanel

public CellPanel getExtraPanel(int optionExtraControl)

Return the extra panel created if any of the OPTION_EXTRA_CONTROLS_XXX options are specified.

Parameters:

optionExtraControl - one of the OPTION_EXTRA_CONTROL_XXX options specified in the constructor.

Returns:

the extra panel created if any of the OPTION_EXTRA_CONTROLS_XXX options are specified, or null if the panel was not created because the specified option was not specified.

setExtraPanelSpacing

public void setExtraPanelSpacing(int pixelSpace)

Set the spacing between the any added extra controls and the scroll bar it is next to.

Parameters:

pixelSpace - the space that will be placed between the specified extra controls and the scroll bar it is next to.

setExtraPanelSpacing

public void setExtraPanelSpacing(int optionExtraControl,
                                 int pixelSpace)

Set the spacing between the specified extra controls and the scroll bar it is next to.

Parameters:

optionExtraControl - any combination of the OPTION_EXTRA_CONTROLS_XXX options.

pixelSpace - the space that will be placed between the specified extra controls and the scroll bar it is next to.

setHorizontalPainter

public ScrollBarPanel setHorizontalPainter(PaintControl pc)

setVerticalPainter

public ScrollBarPanel setVerticalPainter(PaintControl pc)

setOptions

public void setOptions(int options)

Set options for the ScrollablePanel.

Overrides:

setOptions in class ScrollablePanel

checkScrolls

public void checkScrolls(int width,
                         int height,
                         boolean reDraw)

Specified by:

checkScrolls in class ScrollablePanel

updateScroll

public void updateScroll(int which)

Description copied from interface: ScrollServer

This method tells the ScrollServer to update a particular scrolling control.

Parameters:

which - either Horizontal or Vertical.

setScroll

public void setScroll(int which,
                      int v,
                      int a,
                      int c)

onScrollEvent

public void onScrollEvent(ScrollEvent se)

onEvent

public void onEvent(Event ev)

Overrides:

onEvent in class CellPanel

modifyScrollers

public void modifyScrollers(int set,
                            int clear)

Specified by:

modifyScrollers in class ScrollablePanel

dismantle

public void dismantle(Control downTo)

Overrides:

dismantle in class ScrollablePanel