StaffDetails (ProxyMusic 3.0.1 API)

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

public class StaffDetails
extends Object

The staff-details element is used to indicate different types of staves. The optional number attribute specifies the staff number from top to bottom on the system, as with clef. The print-object attribute is used to indicate when a staff is not printed in a part, usually in large scores where empty parts are omitted. It is yes by default. If print-spacing is yes while print-object is no, the score is printed in cutaway format where vertical space is left for the empty part.

Java class for staff-details complex type.

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

 <complexType name="staff-details">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="staff-type" type="{}staff-type" minOccurs="0"/>
         <element name="staff-lines" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" minOccurs="0"/>
         <element name="staff-tuning" type="{}staff-tuning" maxOccurs="unbounded" minOccurs="0"/>
         <element name="capo" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" minOccurs="0"/>
         <element name="staff-size" type="{}non-negative-decimal" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}print-spacing"/>
       <attribute name="number" type="{}staff-number" />
       <attribute name="show-frets" type="{}show-frets" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigInteger`	`capo`
`protected BigInteger`	`number`
`protected YesNo`	`printObject`
`protected YesNo`	`printSpacing`
`protected ShowFrets`	`showFrets`
`protected BigInteger`	`staffLines`
`protected BigDecimal`	`staffSize`
`protected List<StaffTuning>`	`staffTuning`
`protected StaffType`	`staffType`

Constructor Summary

Constructors
Constructor and Description

StaffDetails()

Constructors
Constructor and Description
`StaffDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigInteger`	`getCapo()` Gets the value of the capo property.
`BigInteger`	`getNumber()` Gets the value of the number property.
`YesNo`	`getPrintObject()` Gets the value of the printObject property.
`YesNo`	`getPrintSpacing()` Gets the value of the printSpacing property.
`ShowFrets`	`getShowFrets()` Gets the value of the showFrets property.
`BigInteger`	`getStaffLines()` Gets the value of the staffLines property.
`BigDecimal`	`getStaffSize()` Gets the value of the staffSize property.
`List<StaffTuning>`	`getStaffTuning()` Gets the value of the staffTuning property.
`StaffType`	`getStaffType()` Gets the value of the staffType property.
`void`	`setCapo(BigInteger value)` Sets the value of the capo property.
`void`	`setNumber(BigInteger value)` Sets the value of the number property.
`void`	`setPrintObject(YesNo value)` Sets the value of the printObject property.
`void`	`setPrintSpacing(YesNo value)` Sets the value of the printSpacing property.
`void`	`setShowFrets(ShowFrets value)` Sets the value of the showFrets property.
`void`	`setStaffLines(BigInteger value)` Sets the value of the staffLines property.
`void`	`setStaffSize(BigDecimal value)` Sets the value of the staffSize property.
`void`	`setStaffType(StaffType value)` Sets the value of the staffType property.

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

- Field Detail
  - staffType
```
protected StaffType staffType
```
  - staffLines
```
protected BigInteger staffLines
```
  - staffTuning
```
protected List<StaffTuning> staffTuning
```
  - capo
```
protected BigInteger capo
```
  - staffSize
```
protected BigDecimal staffSize
```
  - number
```
protected BigInteger number
```
  - showFrets
```
protected ShowFrets showFrets
```
  - printObject
```
protected YesNo printObject
```
  - printSpacing
```
protected YesNo printSpacing
```
- Constructor Detail
  - StaffDetails
```
public StaffDetails()
```
- Method Detail
  - getStaffType
```
public StaffType getStaffType()
```
    Gets the value of the staffType property.
    
    Returns:
    
    possible object is StaffType
  - setStaffType
```
public void setStaffType(StaffType value)
```
    Sets the value of the staffType property.
    
    Parameters:
    
    value - allowed object is StaffType
  - getStaffLines
```
public BigInteger getStaffLines()
```
    Gets the value of the staffLines property.
    
    Returns:
    
    possible object is BigInteger
  - setStaffLines
```
public void setStaffLines(BigInteger value)
```
    Sets the value of the staffLines property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getStaffTuning
```
public List<StaffTuning> getStaffTuning()
```
    Gets the value of the staffTuning 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 staffTuning property.
    For example, to add a new item, do as follows:
```
    getStaffTuning().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list StaffTuning
  - getCapo
```
public BigInteger getCapo()
```
    Gets the value of the capo property.
    
    Returns:
    
    possible object is BigInteger
  - setCapo
```
public void setCapo(BigInteger value)
```
    Sets the value of the capo property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getStaffSize
```
public BigDecimal getStaffSize()
```
    Gets the value of the staffSize property.
    
    Returns:
    
    possible object is BigDecimal
  - setStaffSize
```
public void setStaffSize(BigDecimal value)
```
    Sets the value of the staffSize property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getNumber
```
public BigInteger getNumber()
```
    Gets the value of the number property.
    
    Returns:
    
    possible object is BigInteger
  - setNumber
```
public void setNumber(BigInteger value)
```
    Sets the value of the number property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getShowFrets
```
public ShowFrets getShowFrets()
```
    Gets the value of the showFrets property.
    
    Returns:
    
    possible object is ShowFrets
  - setShowFrets
```
public void setShowFrets(ShowFrets value)
```
    Sets the value of the showFrets property.
    
    Parameters:
    
    value - allowed object is ShowFrets
  - 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
  - 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

Class StaffDetails

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

staffType

staffLines

staffTuning

capo

staffSize

number

showFrets

printObject

printSpacing

Constructor Detail

StaffDetails

Method Detail

getStaffType

setStaffType

getStaffLines

setStaffLines

getStaffTuning

getCapo

setCapo

getStaffSize

setStaffSize

getNumber

setNumber

getShowFrets

setShowFrets

getPrintObject

setPrintObject

getPrintSpacing

setPrintSpacing