org.audiveris.proxymusic

Class PartSymbol

java.lang.Object

org.audiveris.proxymusic.PartSymbol

public class PartSymbol
extends Object

The part-symbol type indicates how a symbol for a multi-staff part is indicated in the score; brace is the default value. The top-staff and bottom-staff elements are used when the brace does not extend across the entire part. For example, in a 3-staff organ part, the top-staff will typically be 1 for the right hand, while the bottom-staff will typically be 2 for the left hand. Staff 3 for the pedals is usually outside the brace.

Java class for part-symbol complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="part-symbol">
   <simpleContent>
     <extension base="<>group-symbol-value">
       <attGroup ref="{}position"/>
       <attGroup ref="{}color"/>
       <attribute name="top-staff" type="{}staff-number" />
       <attribute name="bottom-staff" type="{}staff-number" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected BigInteger	bottomStaff
protected String	color
protected BigDecimal	defaultX
protected BigDecimal	defaultY
protected BigDecimal	relativeX
protected BigDecimal	relativeY
protected BigInteger	topStaff
protected GroupSymbolValue	value

Constructor Summary

Constructors

Constructor and Description
PartSymbol()

Method Summary

Modifier and Type	Method and Description
BigInteger	getBottomStaff() Gets the value of the bottomStaff property.
String	getColor() Gets the value of the color property.
BigDecimal	getDefaultX() Gets the value of the defaultX property.
BigDecimal	getDefaultY() Gets the value of the defaultY property.
BigDecimal	getRelativeX() Gets the value of the relativeX property.
BigDecimal	getRelativeY() Gets the value of the relativeY property.
BigInteger	getTopStaff() Gets the value of the topStaff property.
GroupSymbolValue	getValue() The group-symbol-value type indicates how the symbol for a group is indicated in the score.
void	setBottomStaff(BigInteger value) Sets the value of the bottomStaff property.
void	setColor(String value) Sets the value of the color property.
void	setDefaultX(BigDecimal value) Sets the value of the defaultX property.
void	setDefaultY(BigDecimal value) Sets the value of the defaultY property.
void	setRelativeX(BigDecimal value) Sets the value of the relativeX property.
void	setRelativeY(BigDecimal value) Sets the value of the relativeY property.
void	setTopStaff(BigInteger value) Sets the value of the topStaff property.
void	setValue(GroupSymbolValue value) Sets the value of the value property.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected GroupSymbolValue value

topStaff

protected BigInteger topStaff

bottomStaff

protected BigInteger bottomStaff

defaultX

protected BigDecimal defaultX

defaultY

protected BigDecimal defaultY

relativeX

protected BigDecimal relativeX

relativeY

protected BigDecimal relativeY

color

protected String color

Constructor Detail

PartSymbol

public PartSymbol()

Method Detail

getValue

public GroupSymbolValue getValue()

The group-symbol-value type indicates how the symbol for a group is indicated in the score. The default value is none.

Returns:

possible object is GroupSymbolValue

setValue

public void setValue(GroupSymbolValue value)

Sets the value of the value property.

Parameters:

value - allowed object is GroupSymbolValue

getTopStaff

public BigInteger getTopStaff()

Gets the value of the topStaff property.

Returns:

possible object is BigInteger

setTopStaff

public void setTopStaff(BigInteger value)

Sets the value of the topStaff property.

Parameters:

value - allowed object is BigInteger

getBottomStaff

public BigInteger getBottomStaff()

Gets the value of the bottomStaff property.

Returns:

possible object is BigInteger

setBottomStaff

public void setBottomStaff(BigInteger value)

Sets the value of the bottomStaff property.

Parameters:

value - allowed object is BigInteger

getDefaultX

public BigDecimal getDefaultX()

Gets the value of the defaultX property.

Returns:

possible object is BigDecimal

setDefaultX

public void setDefaultX(BigDecimal value)

Sets the value of the defaultX property.

Parameters:

value - allowed object is BigDecimal

getDefaultY

public BigDecimal getDefaultY()

Gets the value of the defaultY property.

Returns:

possible object is BigDecimal

setDefaultY

public void setDefaultY(BigDecimal value)

Sets the value of the defaultY property.

Parameters:

value - allowed object is BigDecimal

getRelativeX

public BigDecimal getRelativeX()

Gets the value of the relativeX property.

Returns:

possible object is BigDecimal

setRelativeX

public void setRelativeX(BigDecimal value)

Sets the value of the relativeX property.

Parameters:

value - allowed object is BigDecimal

getRelativeY

public BigDecimal getRelativeY()

Gets the value of the relativeY property.

Returns:

possible object is BigDecimal

setRelativeY

public void setRelativeY(BigDecimal value)

Sets the value of the relativeY property.

Parameters:

value - allowed object is BigDecimal

getColor

public String getColor()

Gets the value of the color property.

Returns:

possible object is String

setColor

public void setColor(String value)

Sets the value of the color property.

Parameters:

value - allowed object is String