net.charlesames.music.musicxml
Class Words

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.music.musicxml.MusicXmlEntity
          net.charlesames.music.musicxml.DirectionType
              net.charlesames.music.musicxml.Words

public class Words
extends DirectionType

The Words class implements the MusicXML <words> direction type.

Author:

Charles Ames

Method Summary

java.lang.String	beamedEighthNotes(int count) Create a text string which, when displayed using the MaestroTimes font family, will look like a beamed sequence of eighth notes.
boolean	equals(MusicXmlEntity other) Test if this MusicXML entity has the same content as another object.
static Words	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new Words instance and fill it with loaded data.
static Words	getInstance(MusicXmlEntity container) Create a new Words instance.
int	getNumber() Getter for the Number property.
void	putXmlData(org.w3c.dom.Element element)
void	setNumber(int number) Setter for the Number property.
org.w3c.dom.Node	toXmlNode(org.w3c.dom.Node parent) Serialize the content of a MusicXML entity into an XML element.

Methods inherited from class net.charlesames.music.musicxml.DirectionType

dispose, getContent, getDefaultY, getFontFamily, getFontSize, getFontStyle, getFontWeight, getRelativeX, setContent, setDefaultY, setFontFamily, setFontSize, setFontStyle, setFontWeight, setRelativeX

Methods inherited from class net.charlesames.music.musicxml.MusicXmlEntity

getContainer, makeDirty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static Words getInstance(MusicXmlEntity container)

Create a new Words instance.

Parameters:

container - The MusicXmlEntity which will contain the new Words instance.

Returns:

The newly created Words instance.

beamedEighthNotes

public java.lang.String beamedEighthNotes(int count)

Create a text string which, when displayed using the MaestroTimes font family, will look like a beamed sequence of eighth notes.

Parameters:

count - The number of eighth notes under the beam.

Returns:

The text string.

getNumber

public int getNumber()

Getter for the Number property.

Returns:

The current Number value.

setNumber

public void setNumber(int number)

Setter for the Number property.

Parameters:

number - The intended Number value.

fromXmlNode

public static Words fromXmlNode(org.w3c.dom.Element element,
                                MusicXmlEntity container)

Create a new Words instance and fill it with loaded data.

Parameters:

element - The XML element that provides the Words data

container - The MusicXmlEntity which will contain the new Words instance.

Returns:

The newly created Words instance.

toXmlNode

public org.w3c.dom.Node toXmlNode(org.w3c.dom.Node parent)

Description copied from class: MusicXmlEntity

Serialize the content of a MusicXML entity into an XML element.

Specified by:

toXmlNode in class MusicXmlEntity

Parameters:

parent - The XML element which is to receive the data.

Returns:

The newly created XML element.

putXmlData

public void putXmlData(org.w3c.dom.Element element)

Overrides:

putXmlData in class DirectionType

equals

public boolean equals(MusicXmlEntity other)

Description copied from class: MusicXmlEntity

Test if this MusicXML entity has the same content as another object.

Overrides:

equals in class DirectionType

Parameters:

other - The other object.

Returns:

True if both objects have the same content; false otherwise.