Tuplet (ProxyMusic 3.0.1 API)

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

```
public class Tuplet
extends Object
```
A tuplet element is present when a tuplet is to be displayed graphically, in addition to the sound data provided by the time-modification elements. The number attribute is used to distinguish nested tuplets. The bracket attribute is used to indicate the presence of a bracket. If unspecified, the results are implementation-dependent. The line-shape attribute is used to specify whether the bracket is straight or in the older curved or slurred style. It is straight by default. Whereas a time-modification element shows how the cumulative, sounding effect of tuplets and double-note tremolos compare to the written note type, the tuplet element describes how this is displayed. The tuplet element also provides more detailed representation information than the time-modification element, and is needed to represent nested tuplets and other complex tuplets accurately. The show-number attribute is used to display either the number of actual notes, the number of both actual and normal notes, or neither. It is actual by default. The show-type attribute is used to display either the actual type, both the actual and normal types, or neither. It is none by default.
Java class for tuplet complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="tuplet">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="tuplet-actual" type="{}tuplet-portion" minOccurs="0"/>
         <element name="tuplet-normal" type="{}tuplet-portion" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}placement"/>
       <attGroup ref="{}line-shape"/>
       <attGroup ref="{}position"/>
       <attribute name="type" use="required" type="{}start-stop" />
       <attribute name="number" type="{}number-level" />
       <attribute name="bracket" type="{}yes-no" />
       <attribute name="show-number" type="{}show-tuplet" />
       <attribute name="show-type" type="{}show-tuplet" />
     </restriction>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected YesNo`	`bracket`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected LineShape`	`lineShape`
`protected Integer`	`number`
`protected AboveBelow`	`placement`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected ShowTuplet`	`showNumber`
`protected ShowTuplet`	`showType`
`protected TupletPortion`	`tupletActual`
`protected TupletPortion`	`tupletNormal`
`protected StartStop`	`type`

Constructor Summary

Constructors
Constructor and Description

Tuplet()

Constructors
Constructor and Description
`Tuplet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`YesNo`	`getBracket()` Gets the value of the bracket property.
`BigDecimal`	`getDefaultX()` Gets the value of the defaultX property.
`BigDecimal`	`getDefaultY()` Gets the value of the defaultY property.
`LineShape`	`getLineShape()` Gets the value of the lineShape property.
`Integer`	`getNumber()` Gets the value of the number property.
`AboveBelow`	`getPlacement()` Gets the value of the placement property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY property.
`ShowTuplet`	`getShowNumber()` Gets the value of the showNumber property.
`ShowTuplet`	`getShowType()` Gets the value of the showType property.
`TupletPortion`	`getTupletActual()` Gets the value of the tupletActual property.
`TupletPortion`	`getTupletNormal()` Gets the value of the tupletNormal property.
`StartStop`	`getType()` Gets the value of the type property.
`void`	`setBracket(YesNo value)` Sets the value of the bracket property.
`void`	`setDefaultX(BigDecimal value)` Sets the value of the defaultX property.
`void`	`setDefaultY(BigDecimal value)` Sets the value of the defaultY property.
`void`	`setLineShape(LineShape value)` Sets the value of the lineShape property.
`void`	`setNumber(Integer value)` Sets the value of the number property.
`void`	`setPlacement(AboveBelow value)` Sets the value of the placement property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.
`void`	`setShowNumber(ShowTuplet value)` Sets the value of the showNumber property.
`void`	`setShowType(ShowTuplet value)` Sets the value of the showType property.
`void`	`setTupletActual(TupletPortion value)` Sets the value of the tupletActual property.
`void`	`setTupletNormal(TupletPortion value)` Sets the value of the tupletNormal property.
`void`	`setType(StartStop 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
  - tupletActual
```
protected TupletPortion tupletActual
```
  - tupletNormal
```
protected TupletPortion tupletNormal
```
  - type
```
protected StartStop type
```
  - number
```
protected Integer number
```
  - bracket
```
protected YesNo bracket
```
  - showNumber
```
protected ShowTuplet showNumber
```
  - showType
```
protected ShowTuplet showType
```
  - placement
```
protected AboveBelow placement
```
  - lineShape
```
protected LineShape lineShape
```
  - defaultX
```
protected BigDecimal defaultX
```
  - defaultY
```
protected BigDecimal defaultY
```
  - relativeX
```
protected BigDecimal relativeX
```
  - relativeY
```
protected BigDecimal relativeY
```
- Constructor Detail
  - Tuplet
```
public Tuplet()
```
- Method Detail
  - getTupletActual
```
public TupletPortion getTupletActual()
```
    Gets the value of the tupletActual property.
    
    Returns:
    
    possible object is TupletPortion
  - setTupletActual
```
public void setTupletActual(TupletPortion value)
```
    Sets the value of the tupletActual property.
    
    Parameters:
    
    value - allowed object is TupletPortion
  - getTupletNormal
```
public TupletPortion getTupletNormal()
```
    Gets the value of the tupletNormal property.
    
    Returns:
    
    possible object is TupletPortion
  - setTupletNormal
```
public void setTupletNormal(TupletPortion value)
```
    Sets the value of the tupletNormal property.
    
    Parameters:
    
    value - allowed object is TupletPortion
  - getType
```
public StartStop getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is StartStop
  - setType
```
public void setType(StartStop value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is StartStop
  - getNumber
```
public Integer getNumber()
```
    Gets the value of the number property.
    
    Returns:
    
    possible object is Integer
  - setNumber
```
public void setNumber(Integer value)
```
    Sets the value of the number property.
    
    Parameters:
    
    value - allowed object is Integer
  - getBracket
```
public YesNo getBracket()
```
    Gets the value of the bracket property.
    
    Returns:
    
    possible object is YesNo
  - setBracket
```
public void setBracket(YesNo value)
```
    Sets the value of the bracket property.
    
    Parameters:
    
    value - allowed object is YesNo
  - getShowNumber
```
public ShowTuplet getShowNumber()
```
    Gets the value of the showNumber property.
    
    Returns:
    
    possible object is ShowTuplet
  - setShowNumber
```
public void setShowNumber(ShowTuplet value)
```
    Sets the value of the showNumber property.
    
    Parameters:
    
    value - allowed object is ShowTuplet
  - getShowType
```
public ShowTuplet getShowType()
```
    Gets the value of the showType property.
    
    Returns:
    
    possible object is ShowTuplet
  - setShowType
```
public void setShowType(ShowTuplet value)
```
    Sets the value of the showType property.
    
    Parameters:
    
    value - allowed object is ShowTuplet
  - 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
  - getLineShape
```
public LineShape getLineShape()
```
    Gets the value of the lineShape property.
    
    Returns:
    
    possible object is LineShape
  - setLineShape
```
public void setLineShape(LineShape value)
```
    Sets the value of the lineShape property.
    
    Parameters:
    
    value - allowed object is LineShape
  - 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

Class Tuplet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tupletActual

tupletNormal

type

number

bracket

showNumber

showType

placement

lineShape

defaultX

defaultY

relativeX

relativeY

Constructor Detail

Tuplet

Method Detail

getTupletActual

setTupletActual

getTupletNormal

setTupletNormal

getType

setType

getNumber

setNumber

getBracket

setBracket

getShowNumber

setShowNumber

getShowType

setShowType

getPlacement

setPlacement

getLineShape

setLineShape

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY