net.charlesames.music.musicxml
Class CreditWords

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

public class CreditWords
extends MusicXmlEntity

The CreditWords class implements the MusicXML <credit-words> element.

Author:

Charles Ames

Method Summary

void	dispose() Release resources engaged by this object, thus rendering it amenable to garbage collection.
boolean	equals(MusicXmlEntity other) Test if this MusicXML entity has the same content as another object.
static CreditWords	fromXmlNode(org.w3c.dom.Element element, Credit container) Create a new CreditWords instance and fill it with loaded data.
java.lang.String	getContent() Getter for the Content property.
int	getDefaultX() Getter for the DefaultX property.
int	getDefaultY() Getter for the DefaultY property.
double	getFontSize() Getter for the FontSize property.
static CreditWords	getInstance(Credit container) Create a new CreditWords instance.
Justify	getJustify() Getter for the Justify property.
VAlign	getVAlign() Getter for the Justify property.
void	putXmlData(org.w3c.dom.Element element)
void	setContent(java.lang.String content) Setter for the Content property.
void	setDefaultX(int defaultX) Setter for the DefaultX property.
void	setDefaultY(int defaultY) Setter for the DefaultY property.
void	setFontSize(double fontSize) Setter for the FontSize property.
void	setJustify(Justify justify) Setter for the Justify property.
void	setVAlign(VAlign valign) Setter for the VAlign 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.MusicXmlEntity

getContainer, makeDirty

Methods inherited from class java.lang.Object

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

Method Detail

dispose

public void dispose()

Description copied from class: Disposable

Release resources engaged by this object, thus rendering it amenable to garbage collection.

Specified by:

dispose in class Disposable

getInstance

public static CreditWords getInstance(Credit container)

Create a new CreditWords instance.

Parameters:

container - The Credit which will contain the new CreditWords instance.

Returns:

The newly created CreditWords instance.

getDefaultX

public int getDefaultX()

Getter for the DefaultX property.

Returns:

The current DefaultX value.

setDefaultX

public void setDefaultX(int defaultX)

Setter for the DefaultX property.

Parameters:

defaultX - The intended DefaultX value.

getDefaultY

public int getDefaultY()

Getter for the DefaultY property.

Returns:

The current DefaultY value.

setDefaultY

public void setDefaultY(int defaultY)

Setter for the DefaultY property.

Parameters:

defaultY - The intended DefaultY value.

getFontSize

public double getFontSize()

Getter for the FontSize property.

Returns:

The current FontSize value.

setFontSize

public void setFontSize(double fontSize)

Setter for the FontSize property.

Parameters:

fontSize - The intended FontSize value.

getJustify

public Justify getJustify()

Getter for the Justify property.

Returns:

The current Justify value.

setJustify

public void setJustify(Justify justify)

Setter for the Justify property.

Parameters:

justify - The intended Justify value.

getVAlign

public VAlign getVAlign()

Getter for the Justify property.

Returns:

The current Justify value.

setVAlign

public void setVAlign(VAlign valign)

Setter for the VAlign property.

Parameters:

valign - The intended VAlign value.

getContent

public java.lang.String getContent()

Getter for the Content property.

Returns:

The current Content value.

setContent

public void setContent(java.lang.String content)

Setter for the Content property.

Parameters:

content - The intended Content value.

fromXmlNode

public static CreditWords fromXmlNode(org.w3c.dom.Element element,
                                      Credit container)

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

Parameters:

element - The XML element that provides the CreditWords data

container - The Credit which will contain the new CreditWords instance.

Returns:

The newly created CreditWords 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)

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 MusicXmlEntity

Parameters:

other - The other object.

Returns:

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