Ending (ProxyMusic 3.0.1 API)

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

```
public class Ending
extends Object
```
The ending type represents multiple (e.g. first and second) endings. Typically, the start type is associated with the left barline of the first measure in an ending. The stop and discontinue types are associated with the right barline of the last measure in an ending. Stop is used when the ending mark concludes with a downward jog, as is typical for first endings. Discontinue is used when there is no downward jog, as is typical for second endings that do not conclude a piece. The length of the jog can be specified using the end-length attribute. The text-x and text-y attributes are offsets that specify where the baseline of the start of the ending text appears, relative to the start of the ending line. The number attribute reflects the numeric values of what is under the ending line. Single endings such as "1" or comma-separated multiple endings such as "1,2" may be used. The ending element text is used when the text displayed in the ending is different than what appears in the number attribute. The print-object element is used to indicate when an ending is present but not printed, as is often the case for many parts in a full score.
Java class for ending complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="ending">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>string">
       <attGroup ref="{}print-style"/>
       <attGroup ref="{}print-object"/>
       <attribute name="number" use="required" type="{}ending-number" />
       <attribute name="type" use="required" type="{}start-stop-discontinue" />
       <attribute name="end-length" type="{}tenths" />
       <attribute name="text-x" type="{}tenths" />
       <attribute name="text-y" type="{}tenths" />
     </extension>
   </simpleContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected BigDecimal`	`endLength`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected String`	`number`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected BigDecimal`	`textX`
`protected BigDecimal`	`textY`
`protected StartStopDiscontinue`	`type`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description

Ending()

Constructors
Constructor and Description
`Ending()`

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`	`getEndLength()` Gets the value of the endLength 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.
`String`	`getNumber()` Gets the value of the number 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`	`getTextX()` Gets the value of the textX property.
`BigDecimal`	`getTextY()` Gets the value of the textY property.
`StartStopDiscontinue`	`getType()` Gets the value of the type property.
`String`	`getValue()` Gets the value of the value 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`	`setEndLength(BigDecimal value)` Sets the value of the endLength 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`	`setNumber(String value)` Sets the value of the number 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`	`setTextX(BigDecimal value)` Sets the value of the textX property.
`void`	`setTextY(BigDecimal value)` Sets the value of the textY property.
`void`	`setType(StartStopDiscontinue value)` Sets the value of the type property.
`void`	`setValue(String 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 String value
```
  - number
```
protected String number
```
  - type
```
protected StartStopDiscontinue type
```
  - endLength
```
protected BigDecimal endLength
```
  - textX
```
protected BigDecimal textX
```
  - textY
```
protected BigDecimal textY
```
  - 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
```
  - printObject
```
protected YesNo printObject
```
- Constructor Detail
  - Ending
```
public Ending()
```
- Method Detail
  - getValue
```
public String getValue()
```
    Gets the value of the value property.
    
    Returns:
    
    possible object is String
  - setValue
```
public void setValue(String value)
```
    Sets the value of the value property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getType
```
public StartStopDiscontinue getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is StartStopDiscontinue
  - setType
```
public void setType(StartStopDiscontinue value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is StartStopDiscontinue
  - getEndLength
```
public BigDecimal getEndLength()
```
    Gets the value of the endLength property.
    
    Returns:
    
    possible object is BigDecimal
  - setEndLength
```
public void setEndLength(BigDecimal value)
```
    Sets the value of the endLength property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getTextX
```
public BigDecimal getTextX()
```
    Gets the value of the textX property.
    
    Returns:
    
    possible object is BigDecimal
  - setTextX
```
public void setTextX(BigDecimal value)
```
    Sets the value of the textX property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getTextY
```
public BigDecimal getTextY()
```
    Gets the value of the textY property.
    
    Returns:
    
    possible object is BigDecimal
  - setTextY
```
public void setTextY(BigDecimal value)
```
    Sets the value of the textY property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - 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
  - 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

Class Ending

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

number

type

endLength

textX

textY

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

printObject

Constructor Detail

Ending

Method Detail

getValue

setValue

getNumber

setNumber

getType

setType

getEndLength

setEndLength

getTextX

setTextX

getTextY

setTextY

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getPrintObject

setPrintObject