Harmony (ProxyMusic 3.0.1 API)

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

```
public class Harmony
extends Object
```
The harmony type is based on Humdrum's **harm encoding, extended to support chord symbols in popular music as well as functional harmony analysis in classical music. If there are alternate harmonies possible, this can be specified using multiple harmony elements differentiated by type. Explicit harmonies have all note present in the music; implied have some notes missing but implied; alternate represents alternate analyses. The harmony object may be used for analysis or for chord symbols. The print-object attribute controls whether or not anything is printed due to the harmony element. The print-frame attribute controls printing of a frame or fretboard diagram. The print-style attribute group sets the default for the harmony, but individual elements can override this with their own print-style values.
Java class for harmony complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="harmony">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{}harmony-chord" maxOccurs="unbounded"/>
         <element name="frame" type="{}frame" minOccurs="0"/>
         <element name="offset" type="{}offset" minOccurs="0"/>
         <group ref="{}editorial"/>
         <group ref="{}staff" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}print-style"/>
       <attGroup ref="{}placement"/>
       <attribute name="type" type="{}harmony-type" />
       <attribute name="print-frame" 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 String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected FormattedText`	`footnote`
`protected Frame`	`frame`
`protected List<Object>`	`harmonyChord`
`protected Level`	`level`
`protected Offset`	`offset`
`protected AboveBelow`	`placement`
`protected YesNo`	`printFrame`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected BigInteger`	`staff`
`protected HarmonyType`	`type`

Constructor Summary

Constructors
Constructor and Description

Harmony()

Constructors
Constructor and Description
`Harmony()`

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.
`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.
`Frame`	`getFrame()` Gets the value of the frame property.
`List<Object>`	`getHarmonyChord()` Gets the value of the harmonyChord property.
`Level`	`getLevel()` Gets the value of the level property.
`Offset`	`getOffset()` Gets the value of the offset property.
`AboveBelow`	`getPlacement()` Gets the value of the placement property.
`YesNo`	`getPrintFrame()` Gets the value of the printFrame 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.
`BigInteger`	`getStaff()` Gets the value of the staff property.
`HarmonyType`	`getType()` Gets the value of the type 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`	`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`	`setFrame(Frame value)` Sets the value of the frame property.
`void`	`setLevel(Level value)` Sets the value of the level property.
`void`	`setOffset(Offset value)` Sets the value of the offset property.
`void`	`setPlacement(AboveBelow value)` Sets the value of the placement property.
`void`	`setPrintFrame(YesNo value)` Sets the value of the printFrame 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.
`void`	`setStaff(BigInteger value)` Sets the value of the staff property.
`void`	`setType(HarmonyType value)` Sets the value of the type property.

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

- Field Detail
  - harmonyChord
```
protected List<Object> harmonyChord
```
  - frame
```
protected Frame frame
```
  - offset
```
protected Offset offset
```
  - footnote
```
protected FormattedText footnote
```
  - level
```
protected Level level
```
  - staff
```
protected BigInteger staff
```
  - type
```
protected HarmonyType type
```
  - printFrame
```
protected YesNo printFrame
```
  - 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
```
  - placement
```
protected AboveBelow placement
```
- Constructor Detail
  - Harmony
```
public Harmony()
```
- Method Detail
  - getHarmonyChord
```
public List<Object> getHarmonyChord()
```
    Gets the value of the harmonyChord 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 harmonyChord property.
    For example, to add a new item, do as follows:
```
    getHarmonyChord().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Root StyleText Kind Inversion Bass Degree
  - getFrame
```
public Frame getFrame()
```
    Gets the value of the frame property.
    
    Returns:
    
    possible object is Frame
  - setFrame
```
public void setFrame(Frame value)
```
    Sets the value of the frame property.
    
    Parameters:
    
    value - allowed object is Frame
  - getOffset
```
public Offset getOffset()
```
    Gets the value of the offset property.
    
    Returns:
    
    possible object is Offset
  - setOffset
```
public void setOffset(Offset value)
```
    Sets the value of the offset property.
    
    Parameters:
    
    value - allowed object is Offset
  - 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
  - getStaff
```
public BigInteger getStaff()
```
    Gets the value of the staff property.
    
    Returns:
    
    possible object is BigInteger
  - setStaff
```
public void setStaff(BigInteger value)
```
    Sets the value of the staff property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getType
```
public HarmonyType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is HarmonyType
  - setType
```
public void setType(HarmonyType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is HarmonyType
  - getPrintFrame
```
public YesNo getPrintFrame()
```
    Gets the value of the printFrame property.
    
    Returns:
    
    possible object is YesNo
  - setPrintFrame
```
public void setPrintFrame(YesNo value)
```
    Sets the value of the printFrame 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
  - 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

Class Harmony

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

harmonyChord

frame

offset

footnote

level

staff

type

printFrame

printObject

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

placement

Constructor Detail

Harmony

Method Detail

getHarmonyChord

getFrame

setFrame

getOffset

setOffset

getFootnote

setFootnote

getLevel

setLevel

getStaff

setStaff

getType

setType

getPrintFrame

setPrintFrame

getPrintObject

setPrintObject

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getPlacement

setPlacement