net.charlesames.music.musicxml
Class PageLayout

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

public class PageLayout
extends MusicXmlEntity

The PageLayout class implements the MusicXML <page-layout> element.

Author:

Charles Ames

Method Summary

void	addPageMargins(PageMargins pageMargins) Insert a PageMargins instance.
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 PageLayout	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new PageLayout instance and fill it with loaded data.
static PageLayout	getInstance(MusicXmlEntity container) Create a new PageLayout instance.
int	getPageHeight() Getter for the PageHeight property
java.util.SortedMap<java.lang.String,PageMargins>	getPageMarginsList() Get all page margins.
int	getPageWidth() Getter for the PageWidth property
void	putXmlData(org.w3c.dom.Element element)
void	setPageHeight(int pageHeight) Setter for the PageHeight property.
void	setPageWidth(int pageWidth) Setter for the PageWidth 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 PageLayout getInstance(MusicXmlEntity container)

Create a new PageLayout instance.

Parameters:

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

Returns:

The newly created PageLayout instance.

getPageMarginsList

public java.util.SortedMap<java.lang.String,PageMargins> getPageMarginsList()

Get all page margins.

Returns:

A collection of PageMargins instances, indexed by page margins type.

getPageWidth

public int getPageWidth()

Getter for the PageWidth property

Returns:

The current PageWidth value.

setPageWidth

public void setPageWidth(int pageWidth)

Setter for the PageWidth property.

Parameters:

pageWidth - The intended PageWidth value.

getPageHeight

public int getPageHeight()

Getter for the PageHeight property

Returns:

The current PageHeight value.

setPageHeight

public void setPageHeight(int pageHeight)

Setter for the PageHeight property.

Parameters:

pageHeight - The intended PageHeight value.

addPageMargins

public void addPageMargins(PageMargins pageMargins)

Insert a PageMargins instance.

Parameters:

pageMargins - The PageMargins instance.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the PageLayout data

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

Returns:

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