org.ka2ddo.yaac.pluginapi

Interface ExtraColumnProvider

public interface ExtraColumnProvider

This interface defines an object that can provide additional columns for table views in YAAC, in a GUI-platform-independent fashion.

Since:

PROVIDER_API_VERSION == 38

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ExtraColumnProviderChangeListener l) Register a listener to be informed of any changes in the quantity or type of the extra columns provided by this provider, so real-time alterations can be made and immediately reflected in the tabular views displaying the extra columns.
ExtraColumn	getExtraColumn(GuiContentType guiContentType, int relativeColumnIndex) Get the Nth column from this provider for the specified table type.
int	getExtraColumnCount(GuiContentType guiContentType) Get the number of additional table columns this provider can add for the specified type of table view.
void	removeChangeListener(ExtraColumnProviderChangeListener l) Unregister a listener to no longer be informed of any changes in the quantity or type of the extra columns provided by this provider, so real-time alterations can be made and immediately reflected in the tabular views displaying the extra columns.

Method Detail

getExtraColumnCount

int getExtraColumnCount(GuiContentType guiContentType)

Get the number of additional table columns this provider can add for the specified type of table view.

Parameters:

guiContentType - GuiContentType of the table type

Returns:

count of additional columns this provider will provide, or zero if no extras for the specified table type

getExtraColumn

ExtraColumn getExtraColumn(GuiContentType guiContentType,
                           int relativeColumnIndex)

Get the Nth column from this provider for the specified table type. Note that calling this method again with the same arguments will produce a duplicate object, so only call this when initially creating the table model, not from the getValueAt() method or similar real-time methods.

Parameters:

guiContentType - GuiContentType of the table type

relativeColumnIndex - zero-based index of the column relative to this provider for the table type

Returns:

ExtraColumn subclass instance that will provide the data for this column to a table model

addChangeListener

void addChangeListener(ExtraColumnProviderChangeListener l)

Register a listener to be informed of any changes in the quantity or type of the extra columns provided by this provider, so real-time alterations can be made and immediately reflected in the tabular views displaying the extra columns.

Parameters:

l - ExtraColumnProviderChangeListener to register

removeChangeListener

void removeChangeListener(ExtraColumnProviderChangeListener l)

Unregister a listener to no longer be informed of any changes in the quantity or type of the extra columns provided by this provider, so real-time alterations can be made and immediately reflected in the tabular views displaying the extra columns.

Parameters:

l - ExtraColumnProviderChangeListener to unregister