org.lyra.Interface.Options
Class OptionsPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.lyra.Interface.Options.OptionsPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class OptionsPanel
extends javax.swing.JPanel

Certain host features such as consume can be modified from this particular panel. While not necessarily application specific their location is suitable.

Version:
1.0.5, %Revision, 174%, %LastChangedDate, 27/10/12 3:33PM%
Author:
Martin Foster
See Also:
Serialized Form

Nested Class Summary
private  class OptionsPanel.Interact
          The code separation from the user interface.
 
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
private  javax.swing.JCheckBox checkConsume
           
private  javax.swing.JCheckBox checkRandom
           
private  javax.swing.JCheckBox checkRepeat
           
private  javax.swing.JCheckBox checkSingle
           
private  java.util.Set<java.lang.String> Enabled
           
private  Status Info
           
private  OptionsPanel.Interact Interface
           
private  javax.swing.JLabel labelConsume
           
private  javax.swing.JLabel labelCrossfade
           
private  javax.swing.JLabel labelRandom
           
private  javax.swing.JLabel labelRepeat
           
private  javax.swing.JLabel labelSingle
           
private  java.util.Map<java.lang.String,java.lang.String> Lang
           
private  javax.swing.JPanel panelContent
           
private static long serialVersionUID
           
private  javax.swing.JSlider sliderCrossfade
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
OptionsPanel(java.util.Map<java.lang.String,java.lang.String> lang, Status info)
          Main constructor class for the class.
 
Method Summary
private  javax.swing.JCheckBox getCheckConsume()
          This method initialises checkConsume.
private  javax.swing.JCheckBox getCheckRandom()
          This method initialises checkRandom.
private  javax.swing.JCheckBox getCheckRepeat()
          This method initialises checkRepeat.
private  javax.swing.JCheckBox getCheckSingle()
          This method initialises checkSingle.
private  javax.swing.JLabel getLabelConsume()
          This method initialises labelConsume.
private  javax.swing.JLabel getLabelCrossfade()
          This method initialises labelCrossfade.
private  javax.swing.JLabel getLabelRandom()
          This method initialises labelRandom.
private  javax.swing.JLabel getLabelRepeat()
          This method initialises labelRepeat.
private  javax.swing.JLabel getLabelSingle()
          This method initialises labelSingle.
private  javax.swing.JPanel getPanelContent()
           
private  javax.swing.JPanel getPanelRow(javax.swing.JLabel label, javax.swing.JComponent widget)
          This method initialises a JPanel component providing row elements.
private  javax.swing.JSlider getSliderCrossfade()
          This method initialises checkCrossfade.
 java.util.Map<java.lang.String,java.lang.String> getState()
          Will extract the user selected values of stateful elements within this panel.
private  void initFrame()
          This method initialises the baseline elements for the user interface elements.
 void setState()
          Will adjust the state elements of all checkbox and slider bars used within this panel.
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setEnabled, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

panelContent

private javax.swing.JPanel panelContent

labelConsume

private javax.swing.JLabel labelConsume

checkConsume

private javax.swing.JCheckBox checkConsume

labelCrossfade

private javax.swing.JLabel labelCrossfade

sliderCrossfade

private javax.swing.JSlider sliderCrossfade

labelRandom

private javax.swing.JLabel labelRandom

checkRandom

private javax.swing.JCheckBox checkRandom

labelRepeat

private javax.swing.JLabel labelRepeat

checkRepeat

private javax.swing.JCheckBox checkRepeat

labelSingle

private javax.swing.JLabel labelSingle

checkSingle

private javax.swing.JCheckBox checkSingle

Info

private Status Info

Lang

private java.util.Map<java.lang.String,java.lang.String> Lang

Enabled

private java.util.Set<java.lang.String> Enabled

Interface

private OptionsPanel.Interact Interface
Constructor Detail

OptionsPanel

public OptionsPanel(java.util.Map<java.lang.String,java.lang.String> lang,
                    Status info)
Main constructor class for the class. This will generate user elements and permit proper operation due to live values.

Parameters:
lang - Language map for independent language handling.
info - Information class for host state and status.
Method Detail

initFrame

private void initFrame()
This method initialises the baseline elements for the user interface elements. Establishes state elements as well.


getPanelContent

private javax.swing.JPanel getPanelContent()

getCheckConsume

private javax.swing.JCheckBox getCheckConsume()
This method initialises checkConsume. Sets consume state to STATE, STATE should be 0 or 1. When consume is activated, each song played is removed from playlist.

Returns:
javax.swing.JCheckBox

getLabelConsume

private javax.swing.JLabel getLabelConsume()
This method initialises labelConsume.

Returns:
javax.swing.JLabel

getSliderCrossfade

private javax.swing.JSlider getSliderCrossfade()
This method initialises checkCrossfade. Sets crossfading between songs.

Returns:
javax.swing.JSlider

getLabelCrossfade

private javax.swing.JLabel getLabelCrossfade()
This method initialises labelCrossfade.

Returns:
javax.swing.JLabel

getCheckRandom

private javax.swing.JCheckBox getCheckRandom()
This method initialises checkRandom. Sets random state to STATE, STATE should be 0 or 1.
Returns:
javax.swing.JCheckBox

getLabelRandom

private javax.swing.JLabel getLabelRandom()
This method initialises labelRandom.

Returns:
javax.swing.JLabel

getCheckRepeat

private javax.swing.JCheckBox getCheckRepeat()
This method initialises checkRepeat. Sets repeat state to STATE, STATE should be 0 or 1.

Returns:
javax.swing.JCheckBox

getLabelRepeat

private javax.swing.JLabel getLabelRepeat()
This method initialises labelRepeat.

Returns:
javax.swing.JLabel

getCheckSingle

private javax.swing.JCheckBox getCheckSingle()
This method initialises checkSingle. Sets single state to STATE, STATE should be 0 or 1. When single is activated, playback is stopped after current song, or song is repeated if the 'repeat' mode is enabled.

Returns:
javax.swing.JCheckBox

getLabelSingle

private javax.swing.JLabel getLabelSingle()
This method initialises labelSingle.

Returns:
javax.swing.JLabel

getPanelRow

private javax.swing.JPanel getPanelRow(javax.swing.JLabel label,
                                       javax.swing.JComponent widget)
This method initialises a JPanel component providing row elements.

Parameters:
label - JLabel instance which will be resized.
widget - JComponent instance which will be added as-is.
Returns:
JPanel containing the elements properly established.

setState

public void setState()
Will adjust the state elements of all checkbox and slider bars used within this panel.


getState

public java.util.Map<java.lang.String,java.lang.String> getState()
Will extract the user selected values of stateful elements within this panel.

Returns:
Map containing stateful information.