net.charlesames.music.musicxml
Class PageMargins

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

public class PageMargins
extends MusicXmlEntity

The PageMargins class implements the MusicXML <page-margins> 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 PageMargins	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new PageMargins instance and fill it with loaded data.
int	getBottomMargin() Getter for the BottomMargin property
static PageMargins	getInstance(MusicXmlEntity container) Create a new PageMargins instance.
int	getLeftMargin() Getter for the LeftMargin property
int	getRightMargin() Getter for the RightMargin property
int	getTopMargin() Getter for the TopMargin property
java.lang.String	getType() Getter for the Type property
void	putXmlData(org.w3c.dom.Element element)
void	setBottomMargin(int bottomMargin) Setter for the BottomMargin property.
void	setLeftMargin(int leftMargin) Setter for the LeftMargin property.
void	setRightMargin(int rightMargin) Setter for the RightMargin property.
void	setTopMargin(int topMargin) Setter for the TopMargin property.
void	setType(java.lang.String pageMarginsType) Setter for the Type 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 PageMargins getInstance(MusicXmlEntity container)

Create a new PageMargins instance.

Parameters:

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

Returns:

The newly created PageMargins instance.

getType

public java.lang.String getType()

Getter for the Type property

Returns:

The current Type value.

setType

public void setType(java.lang.String pageMarginsType)

Setter for the Type property.

Parameters:

pageMarginsType - The intended Type value.

getRightMargin

public int getRightMargin()

Getter for the RightMargin property

Returns:

The current RightMargin value.

setRightMargin

public void setRightMargin(int rightMargin)

Setter for the RightMargin property.

Parameters:

rightMargin - The intended RightMargin value.

getLeftMargin

public int getLeftMargin()

Getter for the LeftMargin property

Returns:

The current LeftMargin value.

setLeftMargin

public void setLeftMargin(int leftMargin)

Setter for the LeftMargin property.

Parameters:

leftMargin - The intended LeftMargin value.

getTopMargin

public int getTopMargin()

Getter for the TopMargin property

Returns:

The current TopMargin value.

setTopMargin

public void setTopMargin(int topMargin)

Setter for the TopMargin property.

Parameters:

topMargin - The intended TopMargin value.

getBottomMargin

public int getBottomMargin()

Getter for the BottomMargin property

Returns:

The current BottomMargin value.

setBottomMargin

public void setBottomMargin(int bottomMargin)

Setter for the BottomMargin property.

Parameters:

bottomMargin - The intended BottomMargin value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the PageMargins data

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

Returns:

The newly created PageMargins 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.