Package org.jjazz.chordleadsheet.api.item

Interface CLI_ChordSymbol

All Superinterfaces:

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

All Known Implementing Classes:

CLI_ChordSymbol.ComparableCsItem

public interface CLI_ChordSymbol
extends ChordLeadSheetItem<ExtChordSymbol>

A ChordLeadSheetItem which uses ExtChordSymbol objects as data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CLI_ChordSymbol.ComparableCsItem	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 classes/interfaces inherited from interface org.jjazz.chordleadsheet.api.item.ChordLeadSheetItem

ChordLeadSheetItem.ComparableItem, ChordLeadSheetItem.DefaultComparableItem

Field Summary

Fields

Modifier and Type	Field	Description
static final DataFlavor	DATA_FLAVOR

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

PROP_CONTAINER, PROP_ITEM_DATA, PROP_ITEM_POSITION

Method Summary

Static Methods

Modifier and Type	Method	Description
static CLI_ChordSymbol	createItemFrom(int bar)	Create an item at the beginning of the specified bar for comparison purposes.
static CLI_ChordSymbol	createItemFrom(Position pos, boolean inclusive)	Create an item right before the specified position for comparison purposes.
static CLI_ChordSymbol	createItemTo(int bar)	Create an item at the end of the specified bar for comparison purposes.
static CLI_ChordSymbol	createItemTo(Position pos, boolean inclusive)	Create an item right after the specified position for comparison purposes.

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

addPropertyChangeListener, compareTo, getClientProperties, getContainer, getCopy, getData, getPosition, isBarSingleItem, removePropertyChangeListener

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Field Details

DATA_FLAVOR

static final DataFlavor DATA_FLAVOR

Method Details

createItemTo

static CLI_ChordSymbol createItemTo(Position pos,
 boolean inclusive)

Create an item right after the specified position for comparison purposes.

For the Comparable interface, any item whose position is before (or equal if inclusive is true) to pos will be considered BEFORE the returned item.

Parameters:

pos -

inclusive -

Returns:

createItemTo

static CLI_ChordSymbol createItemTo(int bar)

Create an item at the end of the specified bar for comparison purposes.

For the Comparable interface, any normal item in the bar will be considered BEFORE the returned item.

Parameters:

bar -

Returns:

createItemFrom

static CLI_ChordSymbol createItemFrom(Position pos,
 boolean inclusive)

Create an item right before the specified position for comparison purposes.

For the Comparable interface, any item whose position is after (or equal if inclusive is true) to pos will be considered AFTER the returned item.

Parameters:

pos -

inclusive -

Returns:

createItemFrom

static CLI_ChordSymbol createItemFrom(int bar)

Create an item at the beginning of the specified bar for comparison purposes.

For the Comparable interface, any normal item in the bar will be considered AFTER the returned item.

Parameters:

bar -

Returns: