Class ChordRenderingInfo

java.lang.Object

org.jjazz.chordleadsheet.api.item.ChordRenderingInfo

All Implemented Interfaces:

Serializable

public class ChordRenderingInfo
extends Object
implements Serializable

Music rendering info associated to a chord.

This is an immutable class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChordRenderingInfo.Feature	Change the way music is rendered for a chord symbol.
static class	ChordRenderingInfo.XStreamConfig	This enables XStream instance configuration even for private classes or classes from non-public packages of Netbeans modules.

Constructor Summary

Constructors

Constructor	Description
ChordRenderingInfo()	Create an object with default values.
ChordRenderingInfo(EnumSet<ChordRenderingInfo.Feature> features)	Create an object with specified Features and default values.
ChordRenderingInfo(EnumSet<ChordRenderingInfo.Feature> features, StandardScaleInstance scale)	Create a new object with the specified parameters.
ChordRenderingInfo(ChordRenderingInfo cri, EnumSet<ChordRenderingInfo.Feature> features)
ChordRenderingInfo(ChordRenderingInfo cri, StandardScaleInstance scale)
ChordRenderingInfo(StandardScaleInstance scale)	Create an object with specified scale and default values.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ChordRenderingInfo.Feature	getAccentFeature()	Get the accent feature if it's used.
EnumSet<ChordRenderingInfo.Feature>	getFeatures()	Get a copy of the rendering features.
StandardScaleInstance	getScaleInstance()	The standard scale instance that should be used for this chord.
ChordRenderingInfo	getTransposed(int t)	Return a new object transposed by the specified semitones (StandardScaleInstance startNote is impacted).
boolean	hasAllFeatures(ChordRenderingInfo.Feature f1, ChordRenderingInfo.Feature... fx)	Test if this object features contains the specified features.
int	hashCode()
boolean	hasOneFeature(ChordRenderingInfo.Feature f1, ChordRenderingInfo.Feature... fx)	Test if this object features contains one of the specified features.
String	toString()
String	toUserString()	A string representation for UI.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChordRenderingInfo

public ChordRenderingInfo()

Create an object with default values.

ChordRenderingInfo

public ChordRenderingInfo(EnumSet<ChordRenderingInfo.Feature> features)

Create an object with specified Features and default values.

Parameters:

features - If null use the default value.

ChordRenderingInfo

public ChordRenderingInfo(StandardScaleInstance scale)

Create an object with specified scale and default values.

Parameters:

scale - If null use the default value.

ChordRenderingInfo

public ChordRenderingInfo(EnumSet<ChordRenderingInfo.Feature> features,
 StandardScaleInstance scale)

Create a new object with the specified parameters.

Parameters:

features - If null use the default value.

scale - Can be null if no scale defined.

Throws:

IllegalArgumentException - If the features object is not consistent, e.g. SHOT and HOLD can't both be used.

ChordRenderingInfo

public ChordRenderingInfo(ChordRenderingInfo cri,
 StandardScaleInstance scale)

ChordRenderingInfo

public ChordRenderingInfo(ChordRenderingInfo cri,
 EnumSet<ChordRenderingInfo.Feature> features)

Method Details

getFeatures

public EnumSet<ChordRenderingInfo.Feature> getFeatures()

Get a copy of the rendering features.

Default value is an empty EnumSet.

Returns:

getAccentFeature

public ChordRenderingInfo.Feature getAccentFeature()

Get the accent feature if it's used.

Returns:

Can be null.

hasAllFeatures

public boolean hasAllFeatures(ChordRenderingInfo.Feature f1,
 ChordRenderingInfo.Feature... fx)

Test if this object features contains the specified features.

Convenience method because of EnumSet...

Parameters:

f1 -

fx -

Returns:

hasOneFeature

public boolean hasOneFeature(ChordRenderingInfo.Feature f1,
 ChordRenderingInfo.Feature... fx)

Test if this object features contains one of the specified features.

Convenience method because of EnumSet...

Parameters:

f1 -

fx -

Returns:

getTransposed

public ChordRenderingInfo getTransposed(int t)

Return a new object transposed by the specified semitones (StandardScaleInstance startNote is impacted).

Default value is 0.

Parameters:

t - Transposition in semitones.

Returns:

getScaleInstance

public StandardScaleInstance getScaleInstance()

The standard scale instance that should be used for this chord.

Default value is null.

Returns:

Can be null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toUserString

public String toUserString()

A string representation for UI.

Ex: "[Accent, Crash] - Phrygian(C)", or "Phrygian(C)".

Display only meaningful info, eg. do not show Hold/Shot/Extended/Crash/NoCrash if no accent.

Returns:

Can be an empty string