Frame (ProxyMusic 3.0.1 API)

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

public class Frame
extends Object

The frame type represents a frame or fretboard diagram used together with a chord symbol. The representation is based on the NIFF guitar grid with additional information. The frame type's unplayed attribute indicates what to display above a string that has no associated frame-note element. Typical values are x and the empty string. If the attribute is not present, the display of the unplayed string is application-defined.

Java class for frame complex type.

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

 <complexType name="frame">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="frame-strings" type="{http://www.w3.org/2001/XMLSchema}positiveInteger"/>
         <element name="frame-frets" type="{http://www.w3.org/2001/XMLSchema}positiveInteger"/>
         <element name="first-fret" type="{}first-fret" minOccurs="0"/>
         <element name="frame-note" type="{}frame-note" maxOccurs="unbounded"/>
       </sequence>
       <attGroup ref="{}position"/>
       <attGroup ref="{}halign"/>
       <attGroup ref="{}color"/>
       <attGroup ref="{}valign-image"/>
       <attribute name="height" type="{}tenths" />
       <attribute name="width" type="{}tenths" />
       <attribute name="unplayed" type="{http://www.w3.org/2001/XMLSchema}token" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected FirstFret`	`firstFret`
`protected BigInteger`	`frameFrets`
`protected List<FrameNote>`	`frameNote`
`protected BigInteger`	`frameStrings`
`protected LeftCenterRight`	`halign`
`protected BigDecimal`	`height`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected String`	`unplayed`
`protected ValignImage`	`valign`
`protected BigDecimal`	`width`

Constructor Summary

Constructors
Constructor and Description

Frame()

Constructors
Constructor and Description
`Frame()`

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.
`FirstFret`	`getFirstFret()` Gets the value of the firstFret property.
`BigInteger`	`getFrameFrets()` Gets the value of the frameFrets property.
`List<FrameNote>`	`getFrameNote()` Gets the value of the frameNote property.
`BigInteger`	`getFrameStrings()` Gets the value of the frameStrings property.
`LeftCenterRight`	`getHalign()` Gets the value of the halign property.
`BigDecimal`	`getHeight()` Gets the value of the height property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY property.
`String`	`getUnplayed()` Gets the value of the unplayed property.
`ValignImage`	`getValign()` Gets the value of the valign property.
`BigDecimal`	`getWidth()` Gets the value of the width 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`	`setFirstFret(FirstFret value)` Sets the value of the firstFret property.
`void`	`setFrameFrets(BigInteger value)` Sets the value of the frameFrets property.
`void`	`setFrameStrings(BigInteger value)` Sets the value of the frameStrings property.
`void`	`setHalign(LeftCenterRight value)` Sets the value of the halign property.
`void`	`setHeight(BigDecimal value)` Sets the value of the height property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.
`void`	`setUnplayed(String value)` Sets the value of the unplayed property.
`void`	`setValign(ValignImage value)` Sets the value of the valign property.
`void`	`setWidth(BigDecimal value)` Sets the value of the width property.

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

- Field Detail
  - frameStrings
```
protected BigInteger frameStrings
```
  - frameFrets
```
protected BigInteger frameFrets
```
  - firstFret
```
protected FirstFret firstFret
```
  - frameNote
```
protected List<FrameNote> frameNote
```
  - height
```
protected BigDecimal height
```
  - width
```
protected BigDecimal width
```
  - unplayed
```
protected String unplayed
```
  - defaultX
```
protected BigDecimal defaultX
```
  - defaultY
```
protected BigDecimal defaultY
```
  - relativeX
```
protected BigDecimal relativeX
```
  - relativeY
```
protected BigDecimal relativeY
```
  - halign
```
protected LeftCenterRight halign
```
  - color
```
protected String color
```
  - valign
```
protected ValignImage valign
```
- Constructor Detail
  - Frame
```
public Frame()
```
- Method Detail
  - getFrameStrings
```
public BigInteger getFrameStrings()
```
    Gets the value of the frameStrings property.
    
    Returns:
    
    possible object is BigInteger
  - setFrameStrings
```
public void setFrameStrings(BigInteger value)
```
    Sets the value of the frameStrings property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getFrameFrets
```
public BigInteger getFrameFrets()
```
    Gets the value of the frameFrets property.
    
    Returns:
    
    possible object is BigInteger
  - setFrameFrets
```
public void setFrameFrets(BigInteger value)
```
    Sets the value of the frameFrets property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getFirstFret
```
public FirstFret getFirstFret()
```
    Gets the value of the firstFret property.
    
    Returns:
    
    possible object is FirstFret
  - setFirstFret
```
public void setFirstFret(FirstFret value)
```
    Sets the value of the firstFret property.
    
    Parameters:
    
    value - allowed object is FirstFret
  - getFrameNote
```
public List<FrameNote> getFrameNote()
```
    Gets the value of the frameNote 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 frameNote property.
    For example, to add a new item, do as follows:
```
    getFrameNote().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FrameNote
  - getHeight
```
public BigDecimal getHeight()
```
    Gets the value of the height property.
    
    Returns:
    
    possible object is BigDecimal
  - setHeight
```
public void setHeight(BigDecimal value)
```
    Sets the value of the height property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getWidth
```
public BigDecimal getWidth()
```
    Gets the value of the width property.
    
    Returns:
    
    possible object is BigDecimal
  - setWidth
```
public void setWidth(BigDecimal value)
```
    Sets the value of the width property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getUnplayed
```
public String getUnplayed()
```
    Gets the value of the unplayed property.
    
    Returns:
    
    possible object is String
  - setUnplayed
```
public void setUnplayed(String value)
```
    Sets the value of the unplayed property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getHalign
```
public LeftCenterRight getHalign()
```
    Gets the value of the halign property.
    
    Returns:
    
    possible object is LeftCenterRight
  - setHalign
```
public void setHalign(LeftCenterRight value)
```
    Sets the value of the halign property.
    
    Parameters:
    
    value - allowed object is LeftCenterRight
  - 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
  - getValign
```
public ValignImage getValign()
```
    Gets the value of the valign property.
    
    Returns:
    
    possible object is ValignImage
  - setValign
```
public void setValign(ValignImage value)
```
    Sets the value of the valign property.
    
    Parameters:
    
    value - allowed object is ValignImage

Class Frame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

frameStrings

frameFrets

firstFret

frameNote

height

width

unplayed

defaultX

defaultY

relativeX

relativeY

halign

color

valign

Constructor Detail

Frame

Method Detail

getFrameStrings

setFrameStrings

getFrameFrets

setFrameFrets

getFirstFret

setFirstFret

getFrameNote

getHeight

setHeight

getWidth

setWidth

getUnplayed

setUnplayed

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getHalign

setHalign

getColor

setColor

getValign

setValign