Clef (ProxyMusic 3.0.1 API)

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

```
public class Clef
extends Object
```
Clefs are represented by a combination of sign, line, and clef-octave-change elements. The optional number attribute refers to staff numbers within the part. A value of 1 is assumed if not present. Sometimes clefs are added to the staff in non-standard line positions, either to indicate cue passages, or when there are multiple clefs present simultaneously on one staff. In this situation, the additional attribute is set to "yes" and the line value is ignored. The size attribute is used for clefs where the additional attribute is "yes". It is typically used to indicate cue clefs. Sometimes clefs at the start of a measure need to appear after the barline rather than before, as for cues or for use after a repeated section. The after-barline attribute is set to "yes" in this situation. The attribute is ignored for mid-measure clefs. Clefs appear at the start of each system unless the print-object attribute has been set to "no" or the additional attribute has been set to "yes".
Java class for clef complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="clef">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="sign" type="{}clef-sign"/>
         <element name="line" type="{}staff-line" minOccurs="0"/>
         <element name="clef-octave-change" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}print-style"/>
       <attGroup ref="{}print-object"/>
       <attribute name="number" type="{}staff-number" />
       <attribute name="additional" type="{}yes-no" />
       <attribute name="size" type="{}symbol-size" />
       <attribute name="after-barline" type="{}yes-no" />
     </restriction>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected YesNo`	`additional`
`protected YesNo`	`afterBarline`
`protected BigInteger`	`clefOctaveChange`
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected BigInteger`	`line`
`protected BigInteger`	`number`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected ClefSign`	`sign`
`protected SymbolSize`	`size`

Constructor Summary

Constructors
Constructor and Description

Clef()

Constructors
Constructor and Description
`Clef()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`YesNo`	`getAdditional()` Gets the value of the additional property.
`YesNo`	`getAfterBarline()` Gets the value of the afterBarline property.
`BigInteger`	`getClefOctaveChange()` Gets the value of the clefOctaveChange property.
`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.
`BigInteger`	`getLine()` Gets the value of the line property.
`BigInteger`	`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.
`ClefSign`	`getSign()` Gets the value of the sign property.
`SymbolSize`	`getSize()` Gets the value of the size property.
`void`	`setAdditional(YesNo value)` Sets the value of the additional property.
`void`	`setAfterBarline(YesNo value)` Sets the value of the afterBarline property.
`void`	`setClefOctaveChange(BigInteger value)` Sets the value of the clefOctaveChange 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`	`setLine(BigInteger value)` Sets the value of the line property.
`void`	`setNumber(BigInteger 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`	`setSign(ClefSign value)` Sets the value of the sign property.
`void`	`setSize(SymbolSize value)` Sets the value of the size property.

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

- Field Detail
  - sign
```
protected ClefSign sign
```
  - line
```
protected BigInteger line
```
  - clefOctaveChange
```
protected BigInteger clefOctaveChange
```
  - number
```
protected BigInteger number
```
  - additional
```
protected YesNo additional
```
  - size
```
protected SymbolSize size
```
  - afterBarline
```
protected YesNo afterBarline
```
  - 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
  - Clef
```
public Clef()
```
- Method Detail
  - getSign
```
public ClefSign getSign()
```
    Gets the value of the sign property.
    
    Returns:
    
    possible object is ClefSign
  - setSign
```
public void setSign(ClefSign value)
```
    Sets the value of the sign property.
    
    Parameters:
    
    value - allowed object is ClefSign
  - getLine
```
public BigInteger getLine()
```
    Gets the value of the line property.
    
    Returns:
    
    possible object is BigInteger
  - setLine
```
public void setLine(BigInteger value)
```
    Sets the value of the line property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getClefOctaveChange
```
public BigInteger getClefOctaveChange()
```
    Gets the value of the clefOctaveChange property.
    
    Returns:
    
    possible object is BigInteger
  - setClefOctaveChange
```
public void setClefOctaveChange(BigInteger value)
```
    Sets the value of the clefOctaveChange property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - 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
  - getAdditional
```
public YesNo getAdditional()
```
    Gets the value of the additional property.
    
    Returns:
    
    possible object is YesNo
  - setAdditional
```
public void setAdditional(YesNo value)
```
    Sets the value of the additional property.
    
    Parameters:
    
    value - allowed object is YesNo
  - getSize
```
public SymbolSize getSize()
```
    Gets the value of the size property.
    
    Returns:
    
    possible object is SymbolSize
  - setSize
```
public void setSize(SymbolSize value)
```
    Sets the value of the size property.
    
    Parameters:
    
    value - allowed object is SymbolSize
  - getAfterBarline
```
public YesNo getAfterBarline()
```
    Gets the value of the afterBarline property.
    
    Returns:
    
    possible object is YesNo
  - setAfterBarline
```
public void setAfterBarline(YesNo value)
```
    Sets the value of the afterBarline 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
  - 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 Clef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sign

line

clefOctaveChange

number

additional

size

afterBarline

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

printObject

Constructor Detail

Clef

Method Detail

getSign

setSign

getLine

setLine

getClefOctaveChange

setClefOctaveChange

getNumber

setNumber

getAdditional

setAdditional

getSize

setSize

getAfterBarline

setAfterBarline

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getPrintObject

setPrintObject