Package org.audiveris.proxymusic
Class Kind
java.lang.Object
org.audiveris.proxymusic.Kind
Kind indicates the type of chord. Degree elements can then add, subtract, or alter from these starting points
The attributes are used to indicate the formatting of the symbol. Since the kind element is the constant in all the harmony-chord groups that can make up a polychord, many formatting attributes are here.
The use-symbols attribute is yes if the kind should be represented when possible with harmony symbols rather than letters and numbers. These symbols include:
major: a triangle, like Unicode 25B3
minor: -, like Unicode 002D
augmented: +, like Unicode 002B
diminished: °, like Unicode 00B0
half-diminished: ø, like Unicode 00F8
For the major-minor kind, only the minor symbol is used when use-symbols is yes. The major symbol is set using the symbol attribute in the degree-value element. The corresponding degree-alter value will usually be 0 in this case.
The text attribute describes how the kind should be spelled in a score. If use-symbols is yes, the value of the text attribute follows the symbol. The stack-degrees attribute is yes if the degree elements should be stacked above each other. The parentheses-degrees attribute is yes if all the degrees should be in parentheses. The bracket-degrees attribute is yes if all the degrees should be in a bracket. If not specified, these values are implementation-specific. The alignment attributes are for the entire harmony-chord group of which this kind element is a part.
The text attribute may use strings such as "13sus" that refer to both the kind and one or more degree elements. In this case, the corresponding degree elements should have the print-object attribute set to "no" to keep redundant alterations from being displayed.
Java class for kind complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="kind">
<simpleContent>
<extension base="<>kind-value">
<attGroup ref="{}halign"/>
<attGroup ref="{}valign"/>
<attGroup ref="{}print-style"/>
<attribute name="use-symbols" type="{}yes-no" />
<attribute name="text" type="{http://www.w3.org/2001/XMLSchema}token" />
<attribute name="stack-degrees" type="{}yes-no" />
<attribute name="parentheses-degrees" type="{}yes-no" />
<attribute name="bracket-degrees" type="{}yes-no" />
</extension>
</simpleContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected YesNoprotected Stringprotected BigDecimalprotected BigDecimalprotected Stringprotected Stringprotected FontStyleprotected FontWeightprotected LeftCenterRightprotected YesNoprotected BigDecimalprotected BigDecimalprotected YesNoprotected Stringprotected YesNoprotected Valignprotected KindValue -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the bracketDegrees property.getColor()Gets the value of the color property.Gets the value of the defaultX property.Gets the value of the defaultY property.Gets the value of the fontFamily property.Gets the value of the fontSize property.Gets the value of the fontStyle property.Gets the value of the fontWeight property.Gets the value of the halign property.Gets the value of the parenthesesDegrees property.Gets the value of the relativeX property.Gets the value of the relativeY property.Gets the value of the stackDegrees property.getText()Gets the value of the text property.Gets the value of the useSymbols property.Gets the value of the valign property.getValue()A kind-value indicates the type of chord.voidsetBracketDegrees(YesNo value) Sets the value of the bracketDegrees property.voidSets the value of the color property.voidsetDefaultX(BigDecimal value) Sets the value of the defaultX property.voidsetDefaultY(BigDecimal value) Sets the value of the defaultY property.voidsetFontFamily(String value) Sets the value of the fontFamily property.voidsetFontSize(String value) Sets the value of the fontSize property.voidsetFontStyle(FontStyle value) Sets the value of the fontStyle property.voidsetFontWeight(FontWeight value) Sets the value of the fontWeight property.voidsetHalign(LeftCenterRight value) Sets the value of the halign property.voidsetParenthesesDegrees(YesNo value) Sets the value of the parenthesesDegrees property.voidsetRelativeX(BigDecimal value) Sets the value of the relativeX property.voidsetRelativeY(BigDecimal value) Sets the value of the relativeY property.voidsetStackDegrees(YesNo value) Sets the value of the stackDegrees property.voidSets the value of the text property.voidsetUseSymbols(YesNo value) Sets the value of the useSymbols property.voidSets the value of the valign property.voidSets the value of the value property.
-
Field Details
-
value
-
useSymbols
-
text
-
stackDegrees
-
parenthesesDegrees
-
bracketDegrees
-
halign
-
valign
-
color
-
fontFamily
-
fontStyle
-
fontSize
-
fontWeight
-
defaultX
-
defaultY
-
relativeX
-
relativeY
-
-
Constructor Details
-
Kind
public Kind()
-
-
Method Details
-
getValue
A kind-value indicates the type of chord. Degree elements can then add, subtract, or alter from these starting points. Values include: Triads: major (major third, perfect fifth) minor (minor third, perfect fifth) augmented (major third, augmented fifth) diminished (minor third, diminished fifth) Sevenths: dominant (major triad, minor seventh) major-seventh (major triad, major seventh) minor-seventh (minor triad, minor seventh) diminished-seventh (diminished triad, diminished seventh) augmented-seventh (augmented triad, minor seventh) half-diminished (diminished triad, minor seventh) major-minor (minor triad, major seventh) Sixths: major-sixth (major triad, added sixth) minor-sixth (minor triad, added sixth) Ninths: dominant-ninth (dominant-seventh, major ninth) major-ninth (major-seventh, major ninth) minor-ninth (minor-seventh, major ninth) 11ths (usually as the basis for alteration): dominant-11th (dominant-ninth, perfect 11th) major-11th (major-ninth, perfect 11th) minor-11th (minor-ninth, perfect 11th) 13ths (usually as the basis for alteration): dominant-13th (dominant-11th, major 13th) major-13th (major-11th, major 13th) minor-13th (minor-11th, major 13th) Suspended: suspended-second (major second, perfect fifth) suspended-fourth (perfect fourth, perfect fifth) Functional sixths: Neapolitan Italian French German Other: pedal (pedal-point bass) power (perfect fifth) Tristan The "other" kind is used when the harmony is entirely composed of add elements. The "none" kind is used to explicitly encode absence of chords or functional harmony. In this case, the root, numeral, or function element has no meaning. When using the root or numeral element, the root-step or numeral-step text attribute should be set to the empty string to keep the root or numeral from being displayed.- Returns:
- possible object is
KindValue
-
setValue
Sets the value of the value property.- Parameters:
value- allowed object isKindValue
-
getUseSymbols
Gets the value of the useSymbols property.- Returns:
- possible object is
YesNo
-
setUseSymbols
Sets the value of the useSymbols property.- Parameters:
value- allowed object isYesNo
-
getText
Gets the value of the text property.- Returns:
- possible object is
String
-
setText
Sets the value of the text property.- Parameters:
value- allowed object isString
-
getStackDegrees
Gets the value of the stackDegrees property.- Returns:
- possible object is
YesNo
-
setStackDegrees
Sets the value of the stackDegrees property.- Parameters:
value- allowed object isYesNo
-
getParenthesesDegrees
Gets the value of the parenthesesDegrees property.- Returns:
- possible object is
YesNo
-
setParenthesesDegrees
Sets the value of the parenthesesDegrees property.- Parameters:
value- allowed object isYesNo
-
getBracketDegrees
Gets the value of the bracketDegrees property.- Returns:
- possible object is
YesNo
-
setBracketDegrees
Sets the value of the bracketDegrees property.- Parameters:
value- allowed object isYesNo
-
getHalign
Gets the value of the halign property.- Returns:
- possible object is
LeftCenterRight
-
setHalign
Sets the value of the halign property.- Parameters:
value- allowed object isLeftCenterRight
-
getValign
Gets the value of the valign property.- Returns:
- possible object is
Valign
-
setValign
Sets the value of the valign property.- Parameters:
value- allowed object isValign
-
getColor
Gets the value of the color property.- Returns:
- possible object is
String
-
setColor
Sets the value of the color property.- Parameters:
value- allowed object isString
-
getFontFamily
Gets the value of the fontFamily property.- Returns:
- possible object is
String
-
setFontFamily
Sets the value of the fontFamily property.- Parameters:
value- allowed object isString
-
getFontStyle
Gets the value of the fontStyle property.- Returns:
- possible object is
FontStyle
-
setFontStyle
Sets the value of the fontStyle property.- Parameters:
value- allowed object isFontStyle
-
getFontSize
Gets the value of the fontSize property.- Returns:
- possible object is
String
-
setFontSize
Sets the value of the fontSize property.- Parameters:
value- allowed object isString
-
getFontWeight
Gets the value of the fontWeight property.- Returns:
- possible object is
FontWeight
-
setFontWeight
Sets the value of the fontWeight property.- Parameters:
value- allowed object isFontWeight
-
getDefaultX
Gets the value of the defaultX property.- Returns:
- possible object is
BigDecimal
-
setDefaultX
Sets the value of the defaultX property.- Parameters:
value- allowed object isBigDecimal
-
getDefaultY
Gets the value of the defaultY property.- Returns:
- possible object is
BigDecimal
-
setDefaultY
Sets the value of the defaultY property.- Parameters:
value- allowed object isBigDecimal
-
getRelativeX
Gets the value of the relativeX property.- Returns:
- possible object is
BigDecimal
-
setRelativeX
Sets the value of the relativeX property.- Parameters:
value- allowed object isBigDecimal
-
getRelativeY
Gets the value of the relativeY property.- Returns:
- possible object is
BigDecimal
-
setRelativeY
Sets the value of the relativeY property.- Parameters:
value- allowed object isBigDecimal
-