RootAlter (ProxyMusic 3.0.1 API)

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

```
public class RootAlter
extends Object
```
The root-alter type represents the chromatic alteration of the root of the current chord within the harmony element. In some chord styles, the text for the root-step element may include root-alter information. In that case, the print-object attribute of the root-alter element can be set to no. The location attribute indicates whether the alteration should appear to the left or the right of the root-step; it is right by default.
Java class for root-alter complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="root-alter">
   <simpleContent>
     <extension base="<>semitones">
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}print-style"/>
       <attribute name="location" type="{}left-right" />
     </extension>
   </simpleContent>
 </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 LeftRight`	`location`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected BigDecimal`	`value`

Constructor Summary

Constructors
Constructor and Description

RootAlter()

Constructors
Constructor and Description
`RootAlter()`

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.
`LeftRight`	`getLocation()` Gets the value of the location 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.
`BigDecimal`	`getValue()` The semitones type is a number representing semitones, used for chromatic alteration.
`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`	`setLocation(LeftRight value)` Sets the value of the location 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`	`setValue(BigDecimal value)` Sets the value of the value property.

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

- Field Detail
  - value
```
protected BigDecimal value
```
  - location
```
protected LeftRight location
```
  - 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
  - RootAlter
```
public RootAlter()
```
- Method Detail
  - getValue
```
public BigDecimal getValue()
```
    The semitones type is a number representing semitones, used for chromatic alteration. A value of -1 corresponds to a flat and a value of 1 to a sharp. Decimal values like 0.5 (quarter tone sharp) are used for microtones.
    
    Returns:
    
    possible object is BigDecimal
  - setValue
```
public void setValue(BigDecimal value)
```
    Sets the value of the value property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getLocation
```
public LeftRight getLocation()
```
    Gets the value of the location property.
    
    Returns:
    
    possible object is LeftRight
  - setLocation
```
public void setLocation(LeftRight value)
```
    Sets the value of the location property.
    
    Parameters:
    
    value - allowed object is LeftRight
  - 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 RootAlter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

location

printObject

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

Constructor Detail

RootAlter

Method Detail

getValue

setValue

getLocation

setLocation

getPrintObject

setPrintObject

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight