org.lyra.Widgets
Class RatingBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.lyra.Widgets.RatingBar

All Implemented Interfaces:

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

public class RatingBar
extends javax.swing.JPanel

General widget with control methods allowing the instantiation of the rating bar. Two modes are enabled, allowing for editing and the other for straight display and no interaction.

Since:

1.0.2

Version:

1.0.5, %Revision, 174%, %LastChangedDate, 27/10/12 3:33PM%

Author:

Martin Foster

See Also:

Serialized Form

Nested Class Summary

private class

RatingBar.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.table.TableCellEditor	Editor
private javax.swing.ImageIcon	iconEmpty
private javax.swing.ImageIcon	iconFull
private javax.swing.ImageIcon	iconZero
private boolean	Interactive
private RatingBar.Interact	Interface
private javax.swing.JLabel	labelFifth
private javax.swing.JLabel	labelFirst
private javax.swing.JLabel	labelFourth
private javax.swing.JLabel	labelSecond
private javax.swing.JLabel	labelThird
private javax.swing.JLabel	labelZero
private java.lang.String	myValue
private static long	serialVersionUID

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

private

RatingBar(boolean interactive, int level) Base constructor for the class.

Method Summary

int	fetchRating() Fetches the currently set value to whatever is desired.
static RatingBar	getDynamic() Generates a new instance of the rating bar with the ability to change the displayed value.
static RatingBar	getDynamic(int level) Generates a new instance of the rating bar with the ability to change the displayed value.
private javax.swing.JLabel	getLabelFifth() Initialises the labelFift element.
private javax.swing.JLabel	getLabelFirst() Initialises the labelFirst element.
private javax.swing.JLabel	getLabelFourth() Initialises the labelFourth element.
private javax.swing.JLabel	getLabelSecond() Initialises the labelSecond element.
private javax.swing.JLabel	getLabelThird() Initialises the labelThird element.
private javax.swing.JLabel	getLabelZero() Initialises the labelZero element.
static RatingBar	getStatic() Generates a new instance of the rating bar without any interactivity.
static RatingBar	getStatic(int level) Generates a new instance of the rating bar without any interactivity.
private void	initPanel() This method initialises panelRating.
void	updateEditor(javax.swing.table.TableCellEditor editor) Under some circumstances the rating bar will be used in an environment where it will have to indicate that its done with editing.
void	updateRating(int rating) Ratings have to be updated visually otherwise the interface seems a bit less then authentic.

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

labelZero

private javax.swing.JLabel labelZero

labelFirst

private javax.swing.JLabel labelFirst

labelSecond

private javax.swing.JLabel labelSecond

labelThird

private javax.swing.JLabel labelThird

labelFourth

private javax.swing.JLabel labelFourth

labelFifth

private javax.swing.JLabel labelFifth

iconFull

private javax.swing.ImageIcon iconFull

iconEmpty

private javax.swing.ImageIcon iconEmpty

iconZero

private javax.swing.ImageIcon iconZero

myValue

private java.lang.String myValue

Interface

private RatingBar.Interact Interface

Interactive

private boolean Interactive

Editor

private javax.swing.table.TableCellEditor Editor

Constructor Detail

RatingBar

private RatingBar(boolean interactive,
                  int level)

Base constructor for the class. Returns a working instance of the class established for either straight display or modification.

Parameters:

interactive - Flag for instanced interactivity.

level - Level the rating will take initially.

Method Detail

getStatic

public static RatingBar getStatic()

Generates a new instance of the rating bar without any interactivity. This is typically used for static display purposes only.

Returns:

Generated instance of RatingBar.

getStatic

public static RatingBar getStatic(int level)

Generates a new instance of the rating bar without any interactivity. This is typically used for static display purposes only.

Parameters:

level - Integer containing level.

Returns:

Generated instance of RatingBar.

getDynamic

public static RatingBar getDynamic()

Generates a new instance of the rating bar with the ability to change the displayed value. Used in the editor process and also for searching.

Returns:

Generated instance of RatingBar.

getDynamic

public static RatingBar getDynamic(int level)

Generates a new instance of the rating bar with the ability to change the displayed value. Used in the editor process and also for searching.

Parameters:

level - Integer containing level.

Returns:

Generated instance of RatingBar.

initPanel

private void initPanel()

This method initialises panelRating. Provides a search capability for rating elements which are displayed as stars.

getLabelZero

private javax.swing.JLabel getLabelZero()

Initialises the labelZero element. The Zero element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

getLabelFirst

private javax.swing.JLabel getLabelFirst()

Initialises the labelFirst element. The first element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

getLabelSecond

private javax.swing.JLabel getLabelSecond()

Initialises the labelSecond element. The Second element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

getLabelThird

private javax.swing.JLabel getLabelThird()

Initialises the labelThird element. The Third element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

getLabelFourth

private javax.swing.JLabel getLabelFourth()

Initialises the labelFourth element. The Fourth element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

getLabelFifth

private javax.swing.JLabel getLabelFifth()

Initialises the labelFift element. The fifth element in the rating series used to rate a song.

Returns:

javax.swing.JLabel

updateEditor

public void updateEditor(javax.swing.table.TableCellEditor editor)

Under some circumstances the rating bar will be used in an environment where it will have to indicate that its done with editing. When provided with an instance the message will be passed on.

Parameters:

editor - Instance of TableCellEditor to end.

updateRating

public void updateRating(int rating)

Ratings have to be updated visually otherwise the interface seems a bit less then authentic.

Parameters:

rating - Number indicating rating level.

fetchRating

public int fetchRating()

Fetches the currently set value to whatever is desired.

Returns:

Integer containing rating value.