Package org.audiveris.proxymusic

Class Key

java.lang.Object
org.audiveris.proxymusic.Key
public class Key extends Object
The key type represents a key signature. Both traditional and non-traditional key signatures are supported. The optional number attribute refers to staff numbers. If absent, the key signature applies to all staves in the part. Key signatures appear at the start of each system unless the print-object attribute has been set to "no".

Java class for key complex type.

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

 <complexType name="key">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <group ref="{}traditional-key"/>
           <group ref="{}non-traditional-key" maxOccurs="unbounded" minOccurs="0"/>
         </choice>
         <element name="key-octave" type="{}key-octave" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}optional-unique-id"/>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}print-style"/>
       <attribute name="number" type="{}staff-number" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • Key

      public Key()

  • Method Details

    • getCancel

      public Cancel getCancel()
      Gets the value of the cancel property.
      Returns:
      possible object is Cancel

    • setCancel

      public void setCancel(Cancel value)
      Sets the value of the cancel property.
      Parameters:
      value - allowed object is Cancel

    • getFifths

      public BigInteger getFifths()
      Gets the value of the fifths property.
      Returns:
      possible object is BigInteger

    • setFifths

      public void setFifths(BigInteger value)
      Sets the value of the fifths property.
      Parameters:
      value - allowed object is BigInteger

    • getMode

      public String getMode()
      Gets the value of the mode property.
      Returns:
      possible object is String

    • setMode

      public void setMode(String value)
      Sets the value of the mode property.
      Parameters:
      value - allowed object is String

    • getNonTraditionalKey

      public List<Object> getNonTraditionalKey()
      Gets the value of the nonTraditionalKey property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the nonTraditionalKey property.

      For example, to add a new item, do as follows: 

          getNonTraditionalKey().add(newItem);

      Objects of the following type(s) are allowed in the list Step BigDecimal KeyAccidental

    • getKeyOctave

      public List<KeyOctave> getKeyOctave()
      Gets the value of the keyOctave property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the keyOctave property.

      For example, to add a new item, do as follows: 

          getKeyOctave().add(newItem);

      Objects of the following type(s) are allowed in the list KeyOctave

    • 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

    • getId

      public String getId()
      Gets the value of the id property.
      Returns:
      possible object is String

    • setId

      public void setId(String value)
      Sets the value of the id property.
      Parameters:
      value - allowed object is String

    • getPrintObject

      public YesNo getPrintObject()
      Gets the value of the printObject property.
      Returns:
      possible object is YesNo

    • setPrintObject

      public void setPrintObject(YesNo value)
      Sets the value of the printObject property.
      Parameters:
      value - allowed object is YesNo

    • 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

    • getFontFamily

      public String getFontFamily()
      Gets the value of the fontFamily property.
      Returns:
      possible object is String

    • setFontFamily

      public void setFontFamily(String value)
      Sets the value of the fontFamily property.
      Parameters:
      value - allowed object is String

    • getFontStyle

      public FontStyle getFontStyle()
      Gets the value of the fontStyle property.
      Returns:
      possible object is FontStyle

    • setFontStyle

      public void setFontStyle(FontStyle value)
      Sets the value of the fontStyle property.
      Parameters:
      value - allowed object is FontStyle

    • getFontSize

      public String getFontSize()
      Gets the value of the fontSize property.
      Returns:
      possible object is String

    • setFontSize

      public void setFontSize(String value)
      Sets the value of the fontSize property.
      Parameters:
      value - allowed object is String

    • getFontWeight

      public FontWeight getFontWeight()
      Gets the value of the fontWeight property.
      Returns:
      possible object is FontWeight

    • setFontWeight

      public void setFontWeight(FontWeight value)
      Sets the value of the fontWeight property.
      Parameters:
      value - allowed object is FontWeight

    • 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