velox.gui.colors

Class ColorsConfigItem

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

velox.gui.colors.ColorsConfigItem

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ColorsConfigItem
extends javax.swing.JPanel

GUI element that allows easy color selection

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	colorCurrent
protected java.lang.String	text

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 and Description
ColorsConfigItem(java.awt.Color currentColor, java.awt.Color defaultColor, java.util.function.Consumer<java.awt.Color> colorChangedListener) Creates color configuration UI component, similar to the ones Bookmap uses.
ColorsConfigItem(java.awt.Color currentColor, java.awt.Color defaultColor, java.lang.String label, java.util.function.Consumer<java.awt.Color> colorChangedListener) Creates color configuration UI component, similar to the ones Bookmap uses
ColorsConfigItem(java.lang.String text, java.awt.Color defaultColor, IndicatorColorInterface indicatorColorInterface, ColorsChangedListener listener)
ColorsConfigItem(java.lang.String fullName, java.lang.String text, boolean showLabel, java.awt.Color defaultColor, IndicatorColorInterface indicatorColorInterface, ColorsChangedListener listener)
ColorsConfigItem(java.lang.String fullName, java.lang.String text, boolean showLabel, java.awt.Color defaultColor, IndicatorColorInterface indicatorColorInterface, ColorsChangedListener listener, ColorsConfigItemCallbacks callbacks, boolean styleAsMenuItem)
ColorsConfigItem(java.lang.String fullName, java.lang.String text, boolean showLabel, java.awt.Color defaultColor, IndicatorColorInterface indicatorColorInterface, ColorsChangedListener listener, ColorsConfigItemCallbacks callbacks, boolean styleAsMenuItem, java.awt.Insets insets)
ColorsConfigItem(java.lang.String fullName, java.lang.String text, java.awt.Color defaultColor, IndicatorColorInterface indicatorColorInterface, ColorsChangedListener listener)

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor()
java.lang.String	getColorConfigName()
javax.swing.JLabel	getLabel()
protected void	onAdjust()
void	onCurrentColorChanged()
void	onRestore(boolean call)
void	setColor(java.awt.Color color, boolean call)
void	setEnabled(boolean enabled)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

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, 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, getName, 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, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

colorCurrent

protected java.awt.Color colorCurrent

text

protected final java.lang.String text

Constructor Detail

ColorsConfigItem

public ColorsConfigItem(java.awt.Color currentColor,
                        java.awt.Color defaultColor,
                        java.util.function.Consumer<java.awt.Color> colorChangedListener)

Creates color configuration UI component, similar to the ones Bookmap uses. No label is used (equivalent of ColorsConfigItem(Color, Color, String, Consumer) with label set to null}

Parameters:

currentColor - currently selected color (component will be set to it)

defaultColor - default color (when reset button is pressed it will be applied)

colorChangedListener - called when color is changed (regardless of the way it happens - reset also counts as color change)

ColorsConfigItem

public ColorsConfigItem(java.awt.Color currentColor,
                        java.awt.Color defaultColor,
                        java.lang.String label,
                        java.util.function.Consumer<java.awt.Color> colorChangedListener)

Creates color configuration UI component, similar to the ones Bookmap uses

Parameters:

currentColor - currently selected color (component will be set to it)

defaultColor - default color (when reset button is pressed it will be applied)

label - text on the component, null to remove label

colorChangedListener - called when color is changed (regardless of the way it happens - reset also counts as color change)

ColorsConfigItem

public ColorsConfigItem(java.lang.String fullName,
                        java.lang.String text,
                        boolean showLabel,
                        java.awt.Color defaultColor,
                        IndicatorColorInterface indicatorColorInterface,
                        ColorsChangedListener listener)

Parameters:

fullName - full color name

text - text that may be displayed to user

showLabel - false if text should not be displayed, true otherwise

defaultColor - if no color is already in settings for this name, this color will be used. Restoring default will use this color.

listener -

ColorsConfigItem

public ColorsConfigItem(java.lang.String fullName,
                        java.lang.String text,
                        boolean showLabel,
                        java.awt.Color defaultColor,
                        IndicatorColorInterface indicatorColorInterface,
                        ColorsChangedListener listener,
                        ColorsConfigItemCallbacks callbacks,
                        boolean styleAsMenuItem)

Parameters:

fullName - full color name

text - text that may be displayed to user

showLabel - false if text should not be displayed, true otherwise

defaultColor - if no color is already in settings for this name, this color will be used. Restoring default will use this color.

listener -

callbacks - may be null

styleAsMenuItem - if true, item will be styled to put in menu

ColorsConfigItem

public ColorsConfigItem(java.lang.String fullName,
                        java.lang.String text,
                        java.awt.Color defaultColor,
                        IndicatorColorInterface indicatorColorInterface,
                        ColorsChangedListener listener)

Parameters:

fullName -

text - can be null if no label

defaultColor - if no color is already in settings for this name, this color will be used. Restoring default will use this color.

listener -

colorsManager -

ColorsConfigItem

public ColorsConfigItem(java.lang.String text,
                        java.awt.Color defaultColor,
                        IndicatorColorInterface indicatorColorInterface,
                        ColorsChangedListener listener)

ColorsConfigItem

public ColorsConfigItem(java.lang.String fullName,
                        java.lang.String text,
                        boolean showLabel,
                        java.awt.Color defaultColor,
                        IndicatorColorInterface indicatorColorInterface,
                        ColorsChangedListener listener,
                        ColorsConfigItemCallbacks callbacks,
                        boolean styleAsMenuItem,
                        java.awt.Insets insets)

Parameters:

fullName - full color name

text - text that may be displayed to user

showLabel - false if text should not be displayed, true otherwise

defaultColor - if no color is already in settings for this name, this color will be used. Restoring default will use this color.

listener -

callbacks - may be null

styleAsMenuItem - if true, item will be styled to put in menu

Method Detail

getColorConfigName

public java.lang.String getColorConfigName()

getColor

public java.awt.Color getColor()

setColor

public void setColor(java.awt.Color color,
                     boolean call)

onCurrentColorChanged

public void onCurrentColorChanged()

onAdjust

protected void onAdjust()

onRestore

public void onRestore(boolean call)

getLabel

public javax.swing.JLabel getLabel()

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class javax.swing.JComponent