Package org.jjazz.chordleadsheet.api.item

Interface ChordLeadSheetItem<T>

Type Parameters:

T -

All Superinterfaces:

Comparable<ChordLeadSheetItem<?>>, Transferable

All Known Subinterfaces:

CLI_BarAnnotation, CLI_ChordSymbol, CLI_Section

All Known Implementing Classes:

ChordLeadSheetItem.DefaultComparableItem, CLI_ChordSymbol.ComparableCsItem

public interface ChordLeadSheetItem<T>
extends Transferable, Comparable<ChordLeadSheetItem<?>>

Items which belong to a ChordLeadSheet.

PropertyChangeEvents are fired when an attribute is modified.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChordLeadSheetItem.ComparableItem	An interface for items used only for position comparison purposes, when using the NavigableSet/SortedSet-based methods of ChordLeadSheet or ChordSequence.
static class	ChordLeadSheetItem.DefaultComparableItem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_CONTAINER	oldValue=old container, newValue=new container.
static final String	PROP_ITEM_DATA	oldValue=old data, newValue=new data.
static final String	PROP_ITEM_POSITION	oldValue=old position, newValue=new position.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
default int	compareTo(ChordLeadSheetItem<?> other)	First compare using position, then use isBarSingleItem(), then use System.identifyHashCode().
static ChordLeadSheetItem.DefaultComparableItem	createItemFrom(int bar)	Create an item at the beginning of the specified bar for comparison purposes.
static ChordLeadSheetItem.DefaultComparableItem	createItemFrom(Position pos, boolean inclusive)	Create an item right before the specified position for comparison purposes.
static ChordLeadSheetItem.DefaultComparableItem	createItemTo(int bar)	Create an item at the end of the specified bar for comparison purposes.
static ChordLeadSheetItem.DefaultComparableItem	createItemTo(Position pos, boolean inclusive)	Create an item right after the specified position for comparison purposes.
StringProperties	getClientProperties()	Get the client properties.
ChordLeadSheet	getContainer()	Get the ChordLeadSheet this object belongs to.
ChordLeadSheetItem<T>	getCopy(ChordLeadSheet newCls, Position newPos)	Get a copy of this item at a specified position.
T	getData()	Get the data part of this item.
Position	getPosition()	Get a copy of the position of this item.
boolean	isBarSingleItem()	Return true if there can be only one single item perbar, like a time signature.
void	removePropertyChangeListener(PropertyChangeListener listener)

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Field Details

PROP_CONTAINER

static final String PROP_CONTAINER

oldValue=old container, newValue=new container.

See Also:

• Constant Field Values

PROP_ITEM_DATA

static final String PROP_ITEM_DATA

oldValue=old data, newValue=new data.

See Also:

• Constant Field Values

PROP_ITEM_POSITION

static final String PROP_ITEM_POSITION

oldValue=old position, newValue=new position.

See Also:

• Constant Field Values

Method Details

getContainer

ChordLeadSheet getContainer()

Get the ChordLeadSheet this object belongs to.

Returns:

Can be null.

getData

T getData()

Get the data part of this item.

Returns:

getPosition

Position getPosition()

Get a copy of the position of this item.

Returns:

getCopy

ChordLeadSheetItem<T> getCopy(ChordLeadSheet newCls,
 Position newPos)

Get a copy of this item at a specified position.

Client properties are also copied.

Parameters:

newCls - If null, the copy will have the same container that this object.

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

Returns:

isBarSingleItem

boolean isBarSingleItem()

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

Returns:

getClientProperties

StringProperties getClientProperties()

Get the client properties.

Returns:

compareTo

default int compareTo(ChordLeadSheetItem<?> other)

First compare using position, then use isBarSingleItem(), then use System.identifyHashCode().

Performs a special handling for ComparableItems.

Specified by:

compareTo in interface Comparable<T>

Parameters:

other -

Returns:

0 only if this == other, so that comparison is consistent with equals().

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

createItemTo

static ChordLeadSheetItem.DefaultComparableItem 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 ChordLeadSheetItem.DefaultComparableItem 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 ChordLeadSheetItem.DefaultComparableItem 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 ChordLeadSheetItem.DefaultComparableItem 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: