Lyric (ProxyMusic 3.0.1 API)

java.lang.Object
- org.audiveris.proxymusic.Lyric

public class Lyric
extends Object

[JAXB: simplified definition]
The lyric type represents text underlays for lyrics, based on Humdrum with support for other formats. 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 2.0 XSD is more strict than the 2.0 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 (as in Finale's verse / chorus / section specification). Justification is center by default; placement is below by default. The content of the elision type is used to specify the symbol used to display the elision. Common values are a no-break space (Unicode 00A0), an underscore (Unicode 005F), or an undertie (Unicode 203F).

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="{}text-font-color" 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="{}placement"/>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}color"/>
       <attGroup ref="{}position"/>
       <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" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected List<Object>`	`elisionAndSyllabicAndText`
`protected Empty`	`endLine`
`protected Empty`	`endParagraph`
`protected Extend`	`extend`
`protected FormattedText`	`footnote`
`protected Empty`	`humming`
`protected LeftCenterRight`	`justify`
`protected Empty`	`laughing`
`protected Level`	`level`
`protected String`	`name`
`protected String`	`number`
`protected AboveBelow`	`placement`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`

Constructor Summary

Constructors
Constructor and Description

Lyric()

Constructors
Constructor and Description
`Lyric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`List<Object>`	`getElisionAndSyllabicAndText()` Gets the value of the elisionAndSyllabicAndText property.
`Empty`	`getEndLine()` Gets the value of the endLine property.
`Empty`	`getEndParagraph()` Gets the value of the endParagraph property.
`Extend`	`getExtend()` Gets the value of the extend property.
`FormattedText`	`getFootnote()` Gets the value of the footnote property.
`Empty`	`getHumming()` Gets the value of the humming property.
`LeftCenterRight`	`getJustify()` Gets the value of the justify property.
`Empty`	`getLaughing()` Gets the value of the laughing property.
`Level`	`getLevel()` Gets the value of the level property.
`String`	`getName()` Gets the value of the name property.
`String`	`getNumber()` Gets the value of the number property.
`AboveBelow`	`getPlacement()` Gets the value of the placement property.
`YesNo`	`getPrintObject()` Gets the value of the printObject property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY 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`	`setEndLine(Empty value)` Sets the value of the endLine property.
`void`	`setEndParagraph(Empty value)` Sets the value of the endParagraph property.
`void`	`setExtend(Extend value)` Sets the value of the extend property.
`void`	`setFootnote(FormattedText value)` Sets the value of the footnote property.
`void`	`setHumming(Empty value)` Sets the value of the humming property.
`void`	`setJustify(LeftCenterRight value)` Sets the value of the justify property.
`void`	`setLaughing(Empty value)` Sets the value of the laughing property.
`void`	`setLevel(Level value)` Sets the value of the level property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNumber(String value)` Sets the value of the number property.
`void`	`setPlacement(AboveBelow value)` Sets the value of the placement property.
`void`	`setPrintObject(YesNo value)` Sets the value of the printObject property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
```
  - placement
```
protected AboveBelow placement
```
  - printObject
```
protected YesNo printObject
```
  - color
```
protected String color
```
  - defaultX
```
protected BigDecimal defaultX
```
  - defaultY
```
protected BigDecimal defaultY
```
  - relativeX
```
protected BigDecimal relativeX
```
  - relativeY
```
protected BigDecimal relativeY
```
  - justify
```
protected LeftCenterRight justify
```
- Constructor Detail
  - Lyric
```
public Lyric()
```
- Method Detail
  - 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 TextFontColor 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
  - 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
  - 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
  - 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
  - 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

Class Lyric

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elisionAndSyllabicAndText

extend

laughing

humming

endLine

endParagraph

footnote

level

number

name

placement

printObject

color

defaultX

defaultY

relativeX

relativeY

justify

Constructor Detail

Lyric

Method Detail

getElisionAndSyllabicAndText

getExtend

setExtend

getLaughing

setLaughing

getHumming

setHumming

getEndLine

setEndLine

getEndParagraph

setEndParagraph

getFootnote

setFootnote

getLevel

setLevel

getNumber

setNumber

getName

setName

getPlacement

setPlacement

getPrintObject

setPrintObject

getColor

setColor

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getJustify

setJustify