Package org.audiveris.proxymusic

Class Lyric

java.lang.Object
org.audiveris.proxymusic.Lyric
public class Lyric extends Object
[JAXB: simplified definition]
The lyric type represents text underlays for lyrics. Two text elements that are not separated by an elision element are part of the same syllable, but may have different text formatting. The MusicXML XSD is more strict than the DTD in enforcing this by disallowing a second syllabic element unless preceded by an elision element. The lyric number indicates multiple lines, though a name can be used as well. Common name examples are verse and chorus. Justification is center by default; placement is below by default. Vertical alignment is to the baseline of the text and horizontal alignment matches justification. The print-object attribute can override a note's print-lyric attribute in cases where only some lyrics on a note are printed, as when lyrics for later verses are printed in a block of text rather than with each note. The time-only attribute precisely specifies which lyrics are to be sung which time through a repeated section.

Java class for lyric complex type.

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

 <complexType name="lyric">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <sequence>
             <sequence maxOccurs="unbounded" minOccurs="0">
               <element name="elision" type="{}elision" minOccurs="0"/>
               <element name="syllabic" type="{}syllabic" minOccurs="0"/>
               <element name="text" type="{}text-element-data" minOccurs="0"/>
             </sequence>
             <element name="extend" type="{}extend" minOccurs="0"/>
           </sequence>
           <element name="laughing" type="{}empty"/>
           <element name="humming" type="{}empty"/>
         </choice>
         <element name="end-line" type="{}empty" minOccurs="0"/>
         <element name="end-paragraph" type="{}empty" minOccurs="0"/>
         <group ref="{}editorial"/>
       </sequence>
       <attGroup ref="{}position"/>
       <attGroup ref="{}optional-unique-id"/>
       <attGroup ref="{}placement"/>
       <attGroup ref="{}color"/>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}justify"/>
       <attribute name="number" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}token" />
       <attribute name="time-only" type="{}time-only" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • elisionAndSyllabicAndText

      protected List<Object> elisionAndSyllabicAndText

    • extend

      protected Extend extend

    • laughing

      protected Empty laughing

    • humming

      protected Empty humming

    • endLine

      protected Empty endLine

    • endParagraph

      protected Empty endParagraph

    • footnote

      protected FormattedText footnote

    • level

      protected Level level

    • number

      protected String number

    • name

      protected String name

    • timeOnly

      protected String timeOnly

    • defaultX

      protected BigDecimal defaultX

    • defaultY

      protected BigDecimal defaultY

    • relativeX

      protected BigDecimal relativeX

    • relativeY

      protected BigDecimal relativeY

    • id

      protected String id

    • placement

      protected AboveBelow placement

    • color

      protected String color

    • printObject

      protected YesNo printObject

    • justify

      protected LeftCenterRight justify

  • Constructor Details

    • Lyric

      public Lyric()

  • Method Details

    • getElisionAndSyllabicAndText

      public List<Object> getElisionAndSyllabicAndText()
      Gets the value of the elisionAndSyllabicAndText 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 elisionAndSyllabicAndText property.

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

          getElisionAndSyllabicAndText().add(newItem);

      Objects of the following type(s) are allowed in the list Elision Syllabic TextElementData

    • getExtend

      public Extend getExtend()
      Gets the value of the extend property.
      Returns:
      possible object is Extend

    • setExtend

      public void setExtend(Extend value)
      Sets the value of the extend property.
      Parameters:
      value - allowed object is Extend

    • getLaughing

      public Empty getLaughing()
      Gets the value of the laughing property.
      Returns:
      possible object is Empty

    • setLaughing

      public void setLaughing(Empty value)
      Sets the value of the laughing property.
      Parameters:
      value - allowed object is Empty

    • getHumming

      public Empty getHumming()
      Gets the value of the humming property.
      Returns:
      possible object is Empty

    • setHumming

      public void setHumming(Empty value)
      Sets the value of the humming property.
      Parameters:
      value - allowed object is Empty

    • getEndLine

      public Empty getEndLine()
      Gets the value of the endLine property.
      Returns:
      possible object is Empty

    • setEndLine

      public void setEndLine(Empty value)
      Sets the value of the endLine property.
      Parameters:
      value - allowed object is Empty

    • getEndParagraph

      public Empty getEndParagraph()
      Gets the value of the endParagraph property.
      Returns:
      possible object is Empty

    • setEndParagraph

      public void setEndParagraph(Empty value)
      Sets the value of the endParagraph property.
      Parameters:
      value - allowed object is Empty

    • getFootnote

      public FormattedText getFootnote()
      Gets the value of the footnote property.
      Returns:
      possible object is FormattedText

    • setFootnote

      public void setFootnote(FormattedText value)
      Sets the value of the footnote property.
      Parameters:
      value - allowed object is FormattedText

    • getLevel

      public Level getLevel()
      Gets the value of the level property.
      Returns:
      possible object is Level

    • setLevel

      public void setLevel(Level value)
      Sets the value of the level property.
      Parameters:
      value - allowed object is Level

    • getNumber

      public String getNumber()
      Gets the value of the number property.
      Returns:
      possible object is String

    • setNumber

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

    • getName

      public String getName()
      Gets the value of the name property.
      Returns:
      possible object is String

    • setName

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

    • getTimeOnly

      public String getTimeOnly()
      Gets the value of the timeOnly property.
      Returns:
      possible object is String

    • setTimeOnly

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

    • 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

    • 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

    • getPlacement

      public AboveBelow getPlacement()
      Gets the value of the placement property.
      Returns:
      possible object is AboveBelow

    • setPlacement

      public void setPlacement(AboveBelow value)
      Sets the value of the placement property.
      Parameters:
      value - allowed object is AboveBelow

    • 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

    • 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

    • getJustify

      public LeftCenterRight getJustify()
      Gets the value of the justify property.
      Returns:
      possible object is LeftCenterRight

    • setJustify

      public void setJustify(LeftCenterRight value)
      Sets the value of the justify property.
      Parameters:
      value - allowed object is LeftCenterRight