Class CLI_ChordSymbol.ComparableCsItem

java.lang.Object

org.jjazz.chordleadsheet.api.item.CLI_ChordSymbol.ComparableCsItem

All Implemented Interfaces:

Transferable, Comparable<ChordLeadSheetItem<?>>, ChordLeadSheetItem<ExtChordSymbol>, CLI_ChordSymbol

Enclosing interface:

CLI_ChordSymbol

public static class CLI_ChordSymbol.ComparableCsItem
extends Object
implements CLI_ChordSymbol

A dummy CLI_ChordSymbol class which can be used only for position comparison when using the NavigableSet/SortedSet-based methods of ChordLeadSheet or ChordSequence.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jjazz.chordleadsheet.api.item.ChordLeadSheetItem

ChordLeadSheetItem.DefaultComparableItem

Nested classes/interfaces inherited from interface org.jjazz.chordleadsheet.api.item.CLI_ChordSymbol

CLI_ChordSymbol.ComparableCsItem, CLI_ChordSymbol.PositionDisplay

Field Summary

Fields inherited from interface org.jjazz.chordleadsheet.api.item.ChordLeadSheetItem

LOGGER, PROP_CONTAINER, PROP_ITEM_DATA, PROP_ITEM_POSITION

Fields inherited from interface org.jjazz.chordleadsheet.api.item.CLI_ChordSymbol

DATA_FLAVOR, POSITION_ORDER

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
StringProperties	getClientProperties()	Get the client properties.
ChordLeadSheet	getContainer()	Get the ChordLeadSheet this object belongs to.
CLI_ChordSymbol	getCopy(ExtChordSymbol newData, Position newPos)	Get a copy of this item using the specified parameters.
ExtChordSymbol	getData()	Get the data part of this item.
Position	getPosition()	Get a copy of the position of this item.
int	getPositionOrder()	A unique constant value used to order items which have the same position.
Object	getTransferData(DataFlavor flavor)
DataFlavor[]	getTransferDataFlavors()
boolean	isBarSingleItem()	Return true if there can be only one single item perbar, like a time signature.
boolean	isDataFlavorSupported(DataFlavor flavor)
void	removePropertyChangeListener(PropertyChangeListener listener)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jjazz.chordleadsheet.api.item.ChordLeadSheetItem

compareTo

Method Details

getPositionOrder

public int getPositionOrder()

Description copied from interface: ChordLeadSheetItem

A unique constant value used to order items which have the same position.

Specified by:

getPositionOrder in interface ChordLeadSheetItem<ExtChordSymbol>

Returns:

Must be a unique value for each type of item

See Also:

• ChordLeadSheetItem.compareTo(org.jjazz.chordleadsheet.api.item.ChordLeadSheetItem)

getContainer

public ChordLeadSheet getContainer()

Description copied from interface: ChordLeadSheetItem

Get the ChordLeadSheet this object belongs to.

Specified by:

getContainer in interface ChordLeadSheetItem<ExtChordSymbol>

Returns:

Can be null.

getCopy

public CLI_ChordSymbol getCopy(ExtChordSymbol newData,
 Position newPos)

Description copied from interface: ChordLeadSheetItem

Get a copy of this item using the specified parameters.

Client properties are also copied. Returned copy has its ChordLeadSheet container set to null.

Specified by:

getCopy in interface ChordLeadSheetItem<ExtChordSymbol>

Parameters:

newData - If null, the copy will have the same data than this object.

newPos - If null, the copy will have the same position than this object.

Returns:

isBarSingleItem

public boolean isBarSingleItem()

Description copied from interface: ChordLeadSheetItem

Return true if there can be only one single item perbar, like a time signature.

Specified by:

isBarSingleItem in interface ChordLeadSheetItem<ExtChordSymbol>

Returns:

getData

public ExtChordSymbol getData()

Description copied from interface: ChordLeadSheetItem

Get the data part of this item.

Specified by:

getData in interface ChordLeadSheetItem<ExtChordSymbol>

Returns:

getPosition

public Position getPosition()

Description copied from interface: ChordLeadSheetItem

Get a copy of the position of this item.

Specified by:

getPosition in interface ChordLeadSheetItem<ExtChordSymbol>

Returns:

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface ChordLeadSheetItem<ExtChordSymbol>

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface ChordLeadSheetItem<ExtChordSymbol>

getTransferDataFlavors

public DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface Transferable

isDataFlavorSupported

public boolean isDataFlavorSupported(DataFlavor flavor)

Specified by:

isDataFlavorSupported in interface Transferable

getTransferData

public Object getTransferData(DataFlavor flavor)
                       throws UnsupportedFlavorException,
IOException

Specified by:

getTransferData in interface Transferable

Throws:

UnsupportedFlavorException

IOException

toString

public String toString()

Overrides:

toString in class Object

getClientProperties

public StringProperties getClientProperties()

Description copied from interface: ChordLeadSheetItem

Get the client properties.

Specified by:

getClientProperties in interface ChordLeadSheetItem<ExtChordSymbol>

Returns: