FiguredBass (ProxyMusic 3.0.1 API)

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

public class FiguredBass
extends Object

The figured-bass element represents figured bass notation. Figured bass elements take their position from the first regular note (not a grace note or chord note) that follows in score order. The optional duration element is used to indicate changes of figures under a note. Figures are ordered from top to bottom. The value of parentheses is "no" if not present.

Java class for figured-bass complex type.

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

 <complexType name="figured-bass">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="figure" type="{}figure" maxOccurs="unbounded"/>
         <group ref="{}duration" minOccurs="0"/>
         <group ref="{}editorial"/>
       </sequence>
       <attGroup ref="{}printout"/>
       <attGroup ref="{}print-style"/>
       <attribute name="parentheses" type="{}yes-no" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected BigDecimal`	`duration`
`protected List<Figure>`	`figure`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected FormattedText`	`footnote`
`protected Level`	`level`
`protected YesNo`	`parentheses`
`protected YesNo`	`printDot`
`protected YesNo`	`printLyric`
`protected YesNo`	`printObject`
`protected YesNo`	`printSpacing`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`

Constructor Summary

Constructors
Constructor and Description

FiguredBass()

Constructors
Constructor and Description
`FiguredBass()`

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.
`BigDecimal`	`getDuration()` Gets the value of the duration property.
`List<Figure>`	`getFigure()` Gets the value of the figure property.
`String`	`getFontFamily()` Gets the value of the fontFamily property.
`String`	`getFontSize()` Gets the value of the fontSize property.
`FontStyle`	`getFontStyle()` Gets the value of the fontStyle property.
`FontWeight`	`getFontWeight()` Gets the value of the fontWeight property.
`FormattedText`	`getFootnote()` Gets the value of the footnote property.
`Level`	`getLevel()` Gets the value of the level property.
`YesNo`	`getParentheses()` Gets the value of the parentheses property.
`YesNo`	`getPrintDot()` Gets the value of the printDot property.
`YesNo`	`getPrintLyric()` Gets the value of the printLyric property.
`YesNo`	`getPrintObject()` Gets the value of the printObject property.
`YesNo`	`getPrintSpacing()` Gets the value of the printSpacing 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`	`setDuration(BigDecimal value)` Sets the value of the duration property.
`void`	`setFontFamily(String value)` Sets the value of the fontFamily property.
`void`	`setFontSize(String value)` Sets the value of the fontSize property.
`void`	`setFontStyle(FontStyle value)` Sets the value of the fontStyle property.
`void`	`setFontWeight(FontWeight value)` Sets the value of the fontWeight property.
`void`	`setFootnote(FormattedText value)` Sets the value of the footnote property.
`void`	`setLevel(Level value)` Sets the value of the level property.
`void`	`setParentheses(YesNo value)` Sets the value of the parentheses property.
`void`	`setPrintDot(YesNo value)` Sets the value of the printDot property.
`void`	`setPrintLyric(YesNo value)` Sets the value of the printLyric property.
`void`	`setPrintObject(YesNo value)` Sets the value of the printObject property.
`void`	`setPrintSpacing(YesNo value)` Sets the value of the printSpacing 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
  - figure
```
protected List<Figure> figure
```
  - duration
```
protected BigDecimal duration
```
  - footnote
```
protected FormattedText footnote
```
  - level
```
protected Level level
```
  - parentheses
```
protected YesNo parentheses
```
  - printDot
```
protected YesNo printDot
```
  - printLyric
```
protected YesNo printLyric
```
  - printSpacing
```
protected YesNo printSpacing
```
  - printObject
```
protected YesNo printObject
```
  - defaultX
```
protected BigDecimal defaultX
```
  - defaultY
```
protected BigDecimal defaultY
```
  - relativeX
```
protected BigDecimal relativeX
```
  - relativeY
```
protected BigDecimal relativeY
```
  - color
```
protected String color
```
  - fontFamily
```
protected String fontFamily
```
  - fontStyle
```
protected FontStyle fontStyle
```
  - fontSize
```
protected String fontSize
```
  - fontWeight
```
protected FontWeight fontWeight
```
- Constructor Detail
  - FiguredBass
```
public FiguredBass()
```
- Method Detail
  - getFigure
```
public List<Figure> getFigure()
```
    Gets the value of the figure 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 figure property.
    For example, to add a new item, do as follows:
```
    getFigure().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Figure
  - getDuration
```
public BigDecimal getDuration()
```
    Gets the value of the duration property.
    
    Returns:
    
    possible object is BigDecimal
  - setDuration
```
public void setDuration(BigDecimal value)
```
    Sets the value of the duration property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - 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
  - getParentheses
```
public YesNo getParentheses()
```
    Gets the value of the parentheses property.
    
    Returns:
    
    possible object is YesNo
  - setParentheses
```
public void setParentheses(YesNo value)
```
    Sets the value of the parentheses property.
    
    Parameters:
    
    value - allowed object is YesNo
  - getPrintDot
```
public YesNo getPrintDot()
```
    Gets the value of the printDot property.
    
    Returns:
    
    possible object is YesNo
  - setPrintDot
```
public void setPrintDot(YesNo value)
```
    Sets the value of the printDot property.
    
    Parameters:
    
    value - allowed object is YesNo
  - getPrintLyric
```
public YesNo getPrintLyric()
```
    Gets the value of the printLyric property.
    
    Returns:
    
    possible object is YesNo
  - setPrintLyric
```
public void setPrintLyric(YesNo value)
```
    Sets the value of the printLyric property.
    
    Parameters:
    
    value - allowed object is YesNo
  - getPrintSpacing
```
public YesNo getPrintSpacing()
```
    Gets the value of the printSpacing property.
    
    Returns:
    
    possible object is YesNo
  - setPrintSpacing
```
public void setPrintSpacing(YesNo value)
```
    Sets the value of the printSpacing property.
    
    Parameters:
    
    value - allowed object is YesNo
  - 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
  - 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
  - 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

Class FiguredBass

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

figure

duration

footnote

level

parentheses

printDot

printLyric

printSpacing

printObject

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

Constructor Detail

FiguredBass

Method Detail

getFigure

getDuration

setDuration

getFootnote

setFootnote

getLevel

setLevel

getParentheses

setParentheses

getPrintDot

setPrintDot

getPrintLyric

setPrintLyric

getPrintSpacing

setPrintSpacing

getPrintObject

setPrintObject

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight