Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
abc4j API Specification
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

abc.ui.swing
Class JScoreComponent

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by abc.ui.swing.JScoreComponent
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
public class JScoreComponent
extends javax.swing.JComponent

This JComponent displays tunes scores. You can get scores such as :


To render a tune score, just invoke the setTune(Tune) method with your tune as parameter.
Basically, a score if composed of score elements

See Also:
Tune, JScoreElement, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
JScoreComponent()
          Default constructor.
 
Method Summary
 JScoreElement getRenditionElementFor(MusicElement elmnt)
          Returns the graphical element that corresponds to a tune element.
 JScoreElement getScoreElementAt(java.awt.Point location)
          Returns the graphical score element fount at the given location.
 int getStaffLinesSpacing()
           
 boolean isJustified()
          Return true if the rendition staff lines alignment is justified, false otherwise.
 void paint(java.awt.Graphics g)
           
 void setJustification(boolean isJustified)
          Changes the justification of the rendition score.
 void setSelectedItem(JScoreElement elmnt)
          Highlights the given score element in the score.
 void setSelectedItem(MusicElement elmnt)
          Highlights the given score element in the score.
 void setSize(float size)
          The size of the font used to display the music score.
 void setStaffLinesSpacing(int spacing)
           
 void setTune(Tune tune)
          Sets the tune to be renderered.
 void writeScoreTo(java.io.File file)
          Writes the currently set tune score to a PNG file.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JScoreComponent

public JScoreComponent()
Default constructor.

Method Detail

paint

public void paint(java.awt.Graphics g)
Overrides:
paint in class javax.swing.JComponent

setSize

public void setSize(float size)
The size of the font used to display the music score.

Parameters:
size - The size of the font used to display the music score expressed in ?

writeScoreTo

public void writeScoreTo(java.io.File file)
                  throws java.io.IOException
Writes the currently set tune score to a PNG file.

Parameters:
file - The PNG output file.
Throws:
java.io.IOException - Thrown if the given file cannot be accessed.

setTune

public void setTune(Tune tune)
Sets the tune to be renderered.

Parameters:
tune - The tune to be displayed.

setJustification

public void setJustification(boolean isJustified)
Changes the justification of the rendition score. This will set the staff lines aligment to justify in order to have a more elegant display.

Parameters:
isJustified - true if the score rendition should be justified, false otherwise.
See Also:
isJustified()

setStaffLinesSpacing

public void setStaffLinesSpacing(int spacing)

getStaffLinesSpacing

public int getStaffLinesSpacing()

isJustified

public boolean isJustified()
Return true if the rendition staff lines alignment is justified, false otherwise.

Returns:
true if the rendition staff lines alignment is justified, false otherwise.
See Also:
setJustification(boolean)

getScoreElementAt

public JScoreElement getScoreElementAt(java.awt.Point location)
Returns the graphical score element fount at the given location.

Parameters:
location - A point in the score.
Returns:
The graphical score element found at the specified location. null is returned if no item is found at the given location.

setSelectedItem

public void setSelectedItem(MusicElement elmnt)
Highlights the given score element in the score. If an item was previously selected, this previous item is unselected.

Parameters:
elmnt - The music element to be highlighted in the score. null can be specified to remove highlighting.
See Also:
setSelectedItem(JScoreElement)

setSelectedItem

public void setSelectedItem(JScoreElement elmnt)
Highlights the given score element in the score. If an item was previously selected, this previous item is unselected.

Parameters:
elmnt - The score rendition element to be highlighted in the score. null can be specified to remove highlighting.
See Also:
setSelectedItem(MusicElement)

getRenditionElementFor

public JScoreElement getRenditionElementFor(MusicElement elmnt)
Returns the graphical element that corresponds to a tune element.

Parameters:
elmnt - A tune element.
Returns:
The graphical score element that corresponds to the given tune element. null is returned if the given tune element does not have any graphical representation.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
abc4j API Specification
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Submit a bug or feature