FormattedText (ProxyMusic 3.0.1 API)

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

public class FormattedText
extends Object

The formatted-text type represents a text element with text-formatting attributes.

Java class for formatted-text complex type.

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

 <complexType name="formatted-text">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>string">
       <attGroup ref="{}text-formatting"/>
     </extension>
   </simpleContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected TextDirection`	`dir`
`protected EnclosureShape`	`enclosure`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected LeftCenterRight`	`halign`
`protected LeftCenterRight`	`justify`
`protected String`	`lang`
`protected String`	`letterSpacing`
`protected String`	`lineHeight`
`protected Integer`	`lineThrough`
`protected Integer`	`overline`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected BigDecimal`	`rotation`
`protected String`	`space`
`protected Integer`	`underline`
`protected Valign`	`valign`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description

FormattedText()

Constructors
Constructor and Description
`FormattedText()`

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.
`TextDirection`	`getDir()` Gets the value of the dir property.
`EnclosureShape`	`getEnclosure()` Gets the value of the enclosure 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.
`LeftCenterRight`	`getHalign()` Gets the value of the halign property.
`LeftCenterRight`	`getJustify()` Gets the value of the justify property.
`String`	`getLang()` Gets the value of the lang property.
`String`	`getLetterSpacing()` Gets the value of the letterSpacing property.
`String`	`getLineHeight()` Gets the value of the lineHeight property.
`Integer`	`getLineThrough()` Gets the value of the lineThrough property.
`Integer`	`getOverline()` Gets the value of the overline property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY property.
`BigDecimal`	`getRotation()` Gets the value of the rotation property.
`String`	`getSpace()` Gets the value of the space property.
`Integer`	`getUnderline()` Gets the value of the underline property.
`Valign`	`getValign()` Gets the value of the valign 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`	`setDir(TextDirection value)` Sets the value of the dir property.
`void`	`setEnclosure(EnclosureShape value)` Sets the value of the enclosure 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`	`setHalign(LeftCenterRight value)` Sets the value of the halign property.
`void`	`setJustify(LeftCenterRight value)` Sets the value of the justify property.
`void`	`setLang(String value)` Sets the value of the lang property.
`void`	`setLetterSpacing(String value)` Sets the value of the letterSpacing property.
`void`	`setLineHeight(String value)` Sets the value of the lineHeight property.
`void`	`setLineThrough(Integer value)` Sets the value of the lineThrough property.
`void`	`setOverline(Integer value)` Sets the value of the overline property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.
`void`	`setRotation(BigDecimal value)` Sets the value of the rotation property.
`void`	`setSpace(String value)` Sets the value of the space property.
`void`	`setUnderline(Integer value)` Sets the value of the underline property.
`void`	`setValign(Valign value)` Sets the value of the valign 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
```
  - lang
```
protected String lang
```
  - space
```
protected String space
```
  - lineHeight
```
protected String lineHeight
```
  - dir
```
protected TextDirection dir
```
  - enclosure
```
protected EnclosureShape enclosure
```
  - underline
```
protected Integer underline
```
  - overline
```
protected Integer overline
```
  - lineThrough
```
protected Integer lineThrough
```
  - rotation
```
protected BigDecimal rotation
```
  - justify
```
protected LeftCenterRight justify
```
  - valign
```
protected Valign valign
```
  - halign
```
protected LeftCenterRight halign
```
  - 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
```
  - letterSpacing
```
protected String letterSpacing
```
- Constructor Detail
  - FormattedText
```
public FormattedText()
```
- 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
  - getLang
```
public String getLang()
```
    Gets the value of the lang property.
    
    Returns:
    
    possible object is String
  - setLang
```
public void setLang(String value)
```
    Sets the value of the lang property.
    
    Parameters:
    
    value - allowed object is String
  - getSpace
```
public String getSpace()
```
    Gets the value of the space property.
    
    Returns:
    
    possible object is String
  - setSpace
```
public void setSpace(String value)
```
    Sets the value of the space property.
    
    Parameters:
    
    value - allowed object is String
  - getLineHeight
```
public String getLineHeight()
```
    Gets the value of the lineHeight property.
    
    Returns:
    
    possible object is String
  - setLineHeight
```
public void setLineHeight(String value)
```
    Sets the value of the lineHeight property.
    
    Parameters:
    
    value - allowed object is String
  - getDir
```
public TextDirection getDir()
```
    Gets the value of the dir property.
    
    Returns:
    
    possible object is TextDirection
  - setDir
```
public void setDir(TextDirection value)
```
    Sets the value of the dir property.
    
    Parameters:
    
    value - allowed object is TextDirection
  - getEnclosure
```
public EnclosureShape getEnclosure()
```
    Gets the value of the enclosure property.
    
    Returns:
    
    possible object is EnclosureShape
  - setEnclosure
```
public void setEnclosure(EnclosureShape value)
```
    Sets the value of the enclosure property.
    
    Parameters:
    
    value - allowed object is EnclosureShape
  - getUnderline
```
public Integer getUnderline()
```
    Gets the value of the underline property.
    
    Returns:
    
    possible object is Integer
  - setUnderline
```
public void setUnderline(Integer value)
```
    Sets the value of the underline property.
    
    Parameters:
    
    value - allowed object is Integer
  - getOverline
```
public Integer getOverline()
```
    Gets the value of the overline property.
    
    Returns:
    
    possible object is Integer
  - setOverline
```
public void setOverline(Integer value)
```
    Sets the value of the overline property.
    
    Parameters:
    
    value - allowed object is Integer
  - getLineThrough
```
public Integer getLineThrough()
```
    Gets the value of the lineThrough property.
    
    Returns:
    
    possible object is Integer
  - setLineThrough
```
public void setLineThrough(Integer value)
```
    Sets the value of the lineThrough property.
    
    Parameters:
    
    value - allowed object is Integer
  - getRotation
```
public BigDecimal getRotation()
```
    Gets the value of the rotation property.
    
    Returns:
    
    possible object is BigDecimal
  - setRotation
```
public void setRotation(BigDecimal value)
```
    Sets the value of the rotation property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getJustify
```
public LeftCenterRight getJustify()
```
    Gets the value of the justify property.
    
    Returns:
    
    possible object is LeftCenterRight
  - setJustify
```
public void setJustify(LeftCenterRight value)
```
    Sets the value of the justify property.
    
    Parameters:
    
    value - allowed object is LeftCenterRight
  - getValign
```
public Valign getValign()
```
    Gets the value of the valign property.
    
    Returns:
    
    possible object is Valign
  - setValign
```
public void setValign(Valign value)
```
    Sets the value of the valign property.
    
    Parameters:
    
    value - allowed object is Valign
  - 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
  - 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
  - getLetterSpacing
```
public String getLetterSpacing()
```
    Gets the value of the letterSpacing property.
    
    Returns:
    
    possible object is String
  - setLetterSpacing
```
public void setLetterSpacing(String value)
```
    Sets the value of the letterSpacing property.
    
    Parameters:
    
    value - allowed object is String

Class FormattedText

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

lang

space

lineHeight

dir

enclosure

underline

overline

lineThrough

rotation

justify

valign

halign

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

letterSpacing

Constructor Detail

FormattedText

Method Detail

getValue

setValue

getLang

setLang

getSpace

setSpace

getLineHeight

setLineHeight

getDir

setDir

getEnclosure

setEnclosure

getUnderline

setUnderline

getOverline

setOverline

getLineThrough

setLineThrough

getRotation

setRotation

getJustify

setJustify

getValign

setValign

getHalign

setHalign

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getLetterSpacing

setLetterSpacing