public class GUIGauge extends AbstractGUIElement implements GUIGaugeListener
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
private float |
alpha
The gauge alpha value, 1 is opaque and 0 full transparent.
|
private CommandList |
commandList
The
CommandList that is executed on button 2. |
private java.awt.Image |
emptyImage
The image representing an empty gauge.
|
private GaugeState |
gaugeState
The gauge state.
|
private boolean |
hidden
If true, the gauge will not paint itself, whatever its visibility.
|
private Orientation |
orientation
The gauge's orientation.
|
private static long |
serialVersionUID
The serial version UID.
|
private java.lang.String |
tooltipFormat
The tooltip format.
|
private java.lang.String |
tooltipText
The default tooltip text.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
GUIGauge(TooltipManager tooltipManager,
GUIElementListener elementListener,
java.lang.String name,
java.awt.Image fullImage,
java.awt.Image negativeImage,
java.awt.Image emptyImage,
Orientation orientation,
java.lang.String tooltipFormat,
float alpha,
CommandList commandList)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
private java.lang.String |
formatTooltip()
Returns a formatted string using the given format.
|
java.awt.Dimension |
getMaximumSize() |
java.awt.Dimension |
getMinimumSize() |
java.awt.Dimension |
getPreferredSize() |
void |
mouseClicked(java.awt.event.MouseEvent e)
Will be called when the user has clicked (pressed+released) this element.
|
void |
paintComponent(java.awt.Graphics g) |
void |
setBounds(int x,
int y,
int width,
int height) |
void |
setHidden(boolean hidden)
Specify whether this item should hide itself, independent of the
"visibility" state.
|
void |
setValues(int curValue,
int minValue,
int maxValue,
java.lang.String labelText,
java.lang.String tooltipText)
Sets the values to display.
|
private void |
updateTooltipText()
Updates the tooltip's text from
tooltipFormat ad tooltipText . |
dispose, getName, hasTooltipText, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, setChanged, setChangedListener, setDefault, setIgnore, setTooltipText, setTooltipText, toString
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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, 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
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
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, getPeer, 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, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
private final float alpha
@Nullable private final CommandList commandList
CommandList
that is executed on button 2.@Nullable private final java.awt.Image emptyImage
@NotNull private final GaugeState gaugeState
private boolean hidden
@NotNull private final Orientation orientation
private static final long serialVersionUID
@Nullable private final java.lang.String tooltipFormat
formatTooltip()
.@NotNull private java.lang.String tooltipText
public GUIGauge(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, @Nullable java.awt.Image fullImage, @Nullable java.awt.Image negativeImage, @Nullable java.awt.Image emptyImage, @NotNull Orientation orientation, @Nullable java.lang.String tooltipFormat, float alpha, @Nullable CommandList commandList)
tooltipManager
- the tooltip manager to updateelementListener
- the element listener to notifyname
- the name of this elementfullImage
- the image representing a full gaugenegativeImage
- the image representing a more-than-empty gauge; if
set to null
the gauge remains in empty stateemptyImage
- the image representing an empty gauge; if set to null
an empty background is used insteadorientation
- the gauge's orientationtooltipFormat
- the format for displaying tooltips; if set to null
no tooltips are shownalpha
- alpha value of the gauge to usecommandList
- the command list that is executed on button 2@Nullable private java.lang.String formatTooltip()
Supported format strings:
null
to not show a tooltip@Nullable public java.awt.Dimension getMaximumSize()
getMaximumSize
in class javax.swing.JComponent
@Nullable public java.awt.Dimension getMinimumSize()
getMinimumSize
in class javax.swing.JComponent
@Nullable public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public void mouseClicked(@NotNull java.awt.event.MouseEvent e)
GUIElement.mouseReleased(MouseEvent)
.mouseClicked
in interface GUIElement
mouseClicked
in class AbstractGUIElement
e
- the mouse event relative to this elementpublic void paintComponent(@NotNull java.awt.Graphics g)
paintComponent
in class javax.swing.JComponent
public void setBounds(int x, int y, int width, int height)
setBounds
in class java.awt.Component
public void setHidden(boolean hidden)
setHidden
in interface GUIGaugeListener
hidden
- whether the gauge is hiddenpublic void setValues(int curValue, int minValue, int maxValue, @NotNull java.lang.String labelText, @NotNull java.lang.String tooltipText)
setValues
in interface GUIGaugeListener
curValue
- the values to displayminValue
- the minimum possible valuemaxValue
- the maximum possible valuelabelText
- the label texttooltipText
- the tooltip suffixprivate void updateTooltipText()
tooltipFormat
ad tooltipText
.