Package com.realtime.crossfire.jxclient.gui.misc

Class GUIScrollBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar

All Implemented Interfaces:

GUIElement, ScrollableListener, ImageObserver, MenuContainer, Serializable, EventListener

public class GUIScrollBar
extends ActivatableGUIElement
implements ScrollableListener

A scroll bar gui element.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
GUIScrollBar(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull String name, boolean proportionalSlider, @NotNull GUIScrollable2 scrollable, @NotNull Color colorBackground, @NotNull Color colorForeground, @NotNull GuiFactory guiFactory)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	activeChanged()	Will be called whenever the active state has changed.
void	dispose()	Releases all allocated resources.
void	execute()	Executes the actions associated with this GUI element.
@Nullable Dimension	getMinimumSize()
@Nullable Dimension	getPreferredSize()
@Nullable TooltipText	getTooltip()	Returns the current tooltip text.
void	mouseDragged(@NotNull MouseEvent e)	Will be called when the mouse moves within this component while the button is pressed.
void	mousePressed(@NotNull MouseEvent e)	Will be called when the user has pressed the mouse inside this element.
void	mouseReleased(@NotNull MouseEvent e)	Will be called when the user has released the mouse.
void	mouseWheelMoved(int wheelRotation)	Will be called when the mouse wheel has been moved.
void	notifyOpen()	Called each time the enclosing dialog is opened (or raised).
void	paintComponent(@NotNull Graphics g)
void	setRange(int valueMin, int valueMax, int sliderPos, int sliderSize)	Sets the scroll range.

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

activateNextElement, activatePrevElement, isActive, markInactivePending, setActive, setInactiveIfPending, setNextActive, setPrevActive

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, inhibitListeners, isDefault, isIgnore, mouseClicked, mouseEntered, mouseExited, mouseMoved, newTooltipText, setChanged, setChangedListener, setDefault, setIgnore, tooltipChanged, toString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

GUIScrollBar

public GUIScrollBar(@NotNull
 @NotNull TooltipManager tooltipManager,
 @NotNull
 @NotNull GUIElementListener elementListener,
 @NotNull
 @NotNull String name,
 boolean proportionalSlider,
 @NotNull
 @NotNull GUIScrollable2 scrollable,
 @NotNull
 @NotNull Color colorBackground,
 @NotNull
 @NotNull Color colorForeground,
 @NotNull
 @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

proportionalSlider - if set, make the slider size reflect the visible area; if unset, display the slider as a square

scrollable - the target element to scroll

colorBackground - the background color of the slider

colorForeground - the foreground color of the slider

guiFactory - the global GUI factory instance

Method Details

dispose

public void dispose()

Description copied from interface: GUIElement

Releases all allocated resources.

Specified by:

dispose in interface GUIElement

Overrides:

dispose in class AbstractGUIElement

setRange

public void setRange(int valueMin,
 int valueMax,
 int sliderPos,
 int sliderSize)

Description copied from interface: ScrollableListener

Sets the scroll range.

Specified by:

setRange in interface ScrollableListener

Parameters:

valueMin - the minimum scroll value

valueMax - the maximum scroll value

sliderPos - the scroll location; it need not within the scroll range

sliderSize - the size of the slider itself

activeChanged

protected void activeChanged()

Description copied from class: ActivatableGUIElement

Will be called whenever the active state has changed.

Specified by:

activeChanged in class ActivatableGUIElement

mousePressed

public void mousePressed(@NotNull
 @NotNull MouseEvent e)

Description copied from class: ActivatableGUIElement

Will be called when the user has pressed the mouse inside this element.

Specified by:

mousePressed in interface GUIElement

Overrides:

mousePressed in class ActivatableGUIElement

Parameters:

e - the mouse event relative to this element

mouseReleased

public void mouseReleased(@NotNull
 @NotNull MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has released the mouse. This event may be delivered even if no previous GUIElement.mousePressed(MouseEvent) has been delivered before.

Specified by:

mouseReleased in interface GUIElement

Overrides:

mouseReleased in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseDragged

public void mouseDragged(@NotNull
 @NotNull MouseEvent e)

Description copied from interface: GUIElement

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after GUIElement.mouseMoved(MouseEvent).

Note: if the mouse leaves this element's bounding box while the mouse button is still pressed, further mouseDragged (but no mouseMoved) events will be generated.

Specified by:

mouseDragged in interface GUIElement

Overrides:

mouseDragged in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseWheelMoved

public void mouseWheelMoved(int wheelRotation)

Description copied from interface: GUIElement

Will be called when the mouse wheel has been moved.

Specified by:

mouseWheelMoved in interface GUIElement

Overrides:

mouseWheelMoved in class AbstractGUIElement

Parameters:

wheelRotation - the movement amount; negative=away from the user, positive=towards the user

getTooltip

@Nullable
public @Nullable TooltipText getTooltip()

Description copied from class: AbstractGUIElement

Returns the current tooltip text.

Specified by:

getTooltip in class AbstractGUIElement

Returns:

the tooltip text or null to not show a tooltip

notifyOpen

public void notifyOpen()

Description copied from interface: GUIElement

Called each time the enclosing dialog is opened (or raised).

Specified by:

notifyOpen in interface GUIElement

execute

public void execute()

Description copied from class: ActivatableGUIElement

Executes the actions associated with this GUI element. Does nothing if this element has no associated actions.

Specified by:

execute in class ActivatableGUIElement

paintComponent

public void paintComponent(@NotNull
 @NotNull Graphics g)

Overrides:

paintComponent in class JComponent

getPreferredSize

@Nullable
public @Nullable Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getMinimumSize

@Nullable
public @Nullable Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent