org.audiveris.proxymusic

Class KeyOctave

java.lang.Object

org.audiveris.proxymusic.KeyOctave

public class KeyOctave
extends Object

The key-octave element specifies in which octave an element of a key signature appears. The content specifies the octave value using the same values as the display-octave element. The number attribute is a positive integer that refers to the key signature element in left-to-right order. If the cancel attribute is set to yes, then this number refers to an element specified by the cancel element. It is no by default.

Java class for key-octave complex type.

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

 <complexType name="key-octave">
   <simpleContent>
     <extension base="<>octave">
       <attribute name="number" use="required" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" />
       <attribute name="cancel" type="{}yes-no" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected YesNo	cancel
protected BigInteger	number
protected int	value

Constructor Summary

Constructors

Constructor and Description
KeyOctave()

Method Summary

Modifier and Type	Method and Description
YesNo	getCancel() Gets the value of the cancel property.
BigInteger	getNumber() Gets the value of the number property.
int	getValue() Octaves are represented by the numbers 0 to 9, where 4 indicates the octave started by middle C.
void	setCancel(YesNo value) Sets the value of the cancel property.
void	setNumber(BigInteger value) Sets the value of the number property.
void	setValue(int 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 int value

number

protected BigInteger number

cancel

protected YesNo cancel

Constructor Detail

KeyOctave

public KeyOctave()

Method Detail

getValue

public int getValue()

Octaves are represented by the numbers 0 to 9, where 4 indicates the octave started by middle C.

setValue

public void setValue(int value)

Sets the value of the value property.

getNumber

public BigInteger getNumber()

Gets the value of the number property.

Returns:

possible object is BigInteger

setNumber

public void setNumber(BigInteger value)

Sets the value of the number property.

Parameters:

value - allowed object is BigInteger

getCancel

public YesNo getCancel()

Gets the value of the cancel property.

Returns:

possible object is YesNo

setCancel

public void setCancel(YesNo value)

Sets the value of the cancel property.

Parameters:

value - allowed object is YesNo