org.gudy.azureus2.plugins.ui.tables
Interface TableColumn

public interface TableColumn

This interface provides access to an Azureus table column.

Field Summary

static int	ALIGN_CENTER center alignment
static int	ALIGN_LEAD leading alignment
static int	ALIGN_TRAIL trailing alignment
static int	INTERVAL_GRAPHIC Trigger refresh listeners every time a graphic cycle occurs (set by user)
static int	INTERVAL_INVALID_ONLY Trigger refresh only when the cell/row becomes invalid
static int	INTERVAL_LIVE Trigger refresh listeners every time a GUI update cycle occurs (set by user)
static int	POSITION_INVISIBLE For setPosition(int).
static int	POSITION_LAST For setPosition(int).
static int	TYPE_GRAPHIC The graphic type, providing access to graphic specific functions in TableCell.
static int	TYPE_TEXT The cells in this column display textual information.
static int	TYPE_TEXT_ONLY The cells in this column display only textual information, and does not set any other visible properties of cell (background, foreground, icon, etc).

Method Summary

void	addCellAddedListener(TableCellAddedListener listener) Adds a listener that triggers when a TableCell that belongs to this column is being added.
void	addCellDisposeListener(TableCellDisposeListener listener) Adds a listener that triggers when a TableCell that belongs to this column is being disposed.
void	addCellMouseListener(TableCellMouseListener listener) Adds a listener that triggers when a TableCell that belongs to this column has a mouse event.
void	addCellRefreshListener(TableCellRefreshListener listener) Adds a listener that triggers when a TableCell that belongs to this column needs refreshing.
void	addCellToolTipListener(TableCellToolTipListener listener) Adds a listener that triggers when a TableCell that belongs to this column has a tooltip action
TableContextMenuItem	addContextMenuItem(java.lang.String resourceKey) Adds a Context Menu item to the "This Column" sub menu
void	addListeners(java.lang.Object listenerObject) A listener is added for every type of cell listener the supplied object implements
int	getAlignment() Returns the alignment of the column
int	getMaxWidth() Gets the maximum width the column can be Not all UIs may have this feature implemented.
int	getMinWidth() Gets the minimum width that the column can be before other columns start collapsing.
java.lang.String	getName() The logical name of the column.
int	getPosition() Returns the position of the column
int	getPreferredWidth() Gets the preferred width of the coloumn.
int	getRefreshInterval() Returns the refresh interval of the column.
java.lang.String	getTableID() Which table the column will be visible in.
int	getType() Returns the type of the contained data.
java.lang.Object	getUserData(java.lang.String key)
int	getWidth() Returns the column's size
void	initialize(int iAlignment, int iPosition, int iWidth) Initialize a group of variables all at once.
void	initialize(int iAlignment, int iPosition, int iWidth, int iInterval) Initialize a group of variables all at once.
void	invalidateCell(java.lang.Object data_source) Invalidates any cells which are linked to the given data source object.
void	invalidateCells() Invalidate all cells in this column.
boolean	isMaxWidthAuto() Retrieve whether the max width is automatically being set.
boolean	isMinWidthAuto() Retrieve whether the min width is automatically being set
boolean	isObfusticated() Returns whether the column's data will be obfusticated when screen capturing (for bug reports, etc).
boolean	isPreferredWidthAuto() Retrieves whether the preferred width is automatically calculated.
boolean	isVisible() Gets the visibility of the column Not all UIs may have this feature implemented.
void	postConfigLoad() implement this method if you want to be notified when the stored column configuration such as user data or GUI-adjustable properties have been loaded
void	preConfigSave() implement this method if you want to be notified when the column configuration is about to be serialized
void	removeCellAddedListener(TableCellAddedListener listener)
void	removeCellDisposeListener(TableCellDisposeListener listener)
void	removeCellMouseListener(TableCellMouseListener listener) Remove a previously added TableCellMouseListener
void	removeCellRefreshListener(TableCellRefreshListener listener) Removed a previously added TableCellRefreshListener
void	removeCellToolTipListener(TableCellToolTipListener listener)
void	removeUserData(java.lang.String key)
void	setAlignment(int alignment) Orientation of the columns text and header.
void	setMaxWidth(int maxwidth) Sets the maximum width that the column can be Not all UIs may have this feature implemented.
void	setMaxWidthAuto(boolean automaxwidth) Sets whether the max width is automatically set.
void	setMinWidth(int minwidth) Sets the minimum width that the column can be before other columns start collapsing.
void	setMinWidthAuto(boolean autowidth) Sets whether the min width of the column is automatically set.
void	setObfustication(boolean hideData) Sets whether the column's data will be obfusticated during a screen capture (for bug reports, etc).
void	setPosition(int position) Location to put the column.
void	setPreferredWidth(int width) Sets the preferred width of the column.
void	setPreferredWidthAuto(boolean auto) Sets whether the preferred with is automatically calculated.
void	setRefreshInterval(int interval) Set how often the cell receives a refresh() trigger
void	setType(int type) The type of the contained data.
void	setUserData(java.lang.String key, java.lang.Object value) Associates custom data with the column, usually meant for column-specific settings and stores it across sessions
void	setVisible(boolean visible) Sets the visibility of the column
void	setWidth(int width) The column size.
void	setWidthLimits(int min, int max) Sets the minimum and maximum widths in one call Not all UIs may have this min and max limits implemented.

Field Detail

TYPE_TEXT

static final int TYPE_TEXT

The cells in this column display textual information.

See Also:

Constant Field Values

TYPE_GRAPHIC

static final int TYPE_GRAPHIC

The graphic type, providing access to graphic specific functions in TableCell.

See Also:

Constant Field Values

TYPE_TEXT_ONLY

static final int TYPE_TEXT_ONLY

The cells in this column display only textual information, and does not set any other visible properties of cell (background, foreground, icon, etc). Using this type allows azureus to call refresh less, and saves on CPU.

See Also:

Constant Field Values

ALIGN_LEAD

static final int ALIGN_LEAD

leading alignment

See Also:

Constant Field Values

ALIGN_TRAIL

static final int ALIGN_TRAIL

trailing alignment

See Also:

Constant Field Values

ALIGN_CENTER

static final int ALIGN_CENTER

center alignment

See Also:

Constant Field Values

POSITION_INVISIBLE

static final int POSITION_INVISIBLE

For setPosition(int). Make column invisible initially.

See Also:

Constant Field Values

POSITION_LAST

static final int POSITION_LAST

For setPosition(int). Make column the last column initially.

See Also:

Constant Field Values

INTERVAL_GRAPHIC

static final int INTERVAL_GRAPHIC

Trigger refresh listeners every time a graphic cycle occurs (set by user)

See Also:

Constant Field Values

INTERVAL_LIVE

static final int INTERVAL_LIVE

Trigger refresh listeners every time a GUI update cycle occurs (set by user)

See Also:

Constant Field Values

INTERVAL_INVALID_ONLY

static final int INTERVAL_INVALID_ONLY

Trigger refresh only when the cell/row becomes invalid

See Also:

Constant Field Values

Method Detail

initialize

void initialize(int iAlignment,
                int iPosition,
                int iWidth,
                int iInterval)

Initialize a group of variables all at once. Saves on individual setXxx.

Parameters:

iAlignment - See setAlignment(int)

iPosition - See setPosition(int)

iWidth - See setWidth(int)

iInterval - See setRefreshInterval(int)

Since:

2.1.0.0

initialize

void initialize(int iAlignment,
                int iPosition,
                int iWidth)

Initialize a group of variables all at once. Saves on individual setXxx.

Parameters:

iAlignment - See setAlignment(int)

iPosition - See setPosition(int)

iWidth - See setWidth(int)

Since:

2.1.0.0

getName

java.lang.String getName()

The logical name of the column. This was set via TableManager.createColumn(java.lang.String, java.lang.String) and can not be changed.

Returns:

the column name (identification)

Since:

2.1.0.0

getTableID

java.lang.String getTableID()

Which table the column will be visible in. This was set via TableManager.createColumn(java.lang.String, java.lang.String) and can not be changed.

Returns:

TableManager.TABLE_* constant(s)

Since:

2.1.0.0

setType

void setType(int type)

The type of the contained data.
Current supported types are long, string, and graphic.

NOTE: This MUST be set BEFORE adding the column to a table.
The default type is TYPE_TEXT_ONLY.

Parameters:

type - TYPE_TEXT, TYPE_TEXT_ONLY, TYPE_GRAPHIC

Since:

2.1.0.0

getType

int getType()

Returns the type of the contained data.

Returns:

type TYPE_TEXT, or TYPE_GRAPHIC

Since:

2.1.0.0

setWidth

void setWidth(int width)

The column size.

NOTE: This MUST be set BEFORE adding the column to a table.

Parameters:

width - the size in pixels

Since:

2.1.0.0

getWidth

int getWidth()

Returns the column's size

Returns:

width in pixels

Since:

2.1.0.0

setPosition

void setPosition(int position)

Location to put the column. When set before being added to the UI (see TableManager.addColumn(org.gudy.azureus2.plugins.ui.tables.TableColumn)), the supplied value will be used as the default position. If the user has moved the column previously, the new position will be used, and the default position will be ignored. This function cannot be called after you have added the column to a UI table. In the future, setting the position after adding the column to the UI table will result in the column being moved.

Parameters:

position - Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST

Since:

2.1.0.0

getPosition

int getPosition()

Returns the position of the column

Returns:

Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST

Since:

2.1.0.0

setAlignment

void setAlignment(int alignment)

Orientation of the columns text and header.

NOTE: This MUST be set BEFORE adding the column to a table.

Parameters:

alignment - ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER

Since:

2.1.0.0

getAlignment

int getAlignment()

Returns the alignment of the column

Returns:

ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER

Since:

2.1.0.0

setRefreshInterval

void setRefreshInterval(int interval)

Set how often the cell receives a refresh() trigger

Parameters:

interval - INTERVAL_GRAPHIC, INTERVAL_LIVE, INTERVAL_INVALID_ONLY constants, or an integer based on the user-configurable "GUI refresh interval". For example, specifying 4 will result in a refresh trigger every 4 "GUI refresh intervals"

Since:

2.1.0.0

getRefreshInterval

int getRefreshInterval()

Returns the refresh interval of the column. The default is INTERVAL_INVALID_ONLY

Returns:

INTERVAL_* constant, or a number representing the # of GUI refresh cycles between each cell refresh call.

Since:

2.1.0.0

setMinWidth

void setMinWidth(int minwidth)

Sets the minimum width that the column can be before other columns start collapsing. This may not prevent the user from resizing the column smaller than specified.

If not set, the width specified on initialize will be the minimum width

Not all UIs may have this feature implemented.

Parameters:

minwidth - new minumum width

Since:

3.0.0.7

getMinWidth

int getMinWidth()

Gets the minimum width that the column can be before other columns start collapsing.

If not set, the width specified on initialize will be the minimum width

Not all UIs may have this feature implemented.

Returns:

minumum width of the column

Since:

3.0.0.7

setMaxWidth

void setMaxWidth(int maxwidth)

Sets the maximum width that the column can be

Not all UIs may have this feature implemented.

Parameters:

maxwidth - new maximum width

Since:

3.0.0.7

getMaxWidth

int getMaxWidth()

Gets the maximum width the column can be

Not all UIs may have this feature implemented.

Returns:

maximum width of column

Since:

3.0.0.7

setWidthLimits

void setWidthLimits(int min,
                    int max)

Sets the minimum and maximum widths in one call

Not all UIs may have this min and max limits implemented.

Parameters:

min - New minimum column width

max - New maximum column width

Since:

3.0.0.7

setMaxWidthAuto

void setMaxWidthAuto(boolean automaxwidth)

Sets whether the max width is automatically set. Depending on the UI, automatically setting the max width usually results in the maximum width being grown to fit the largest text set for any cell (past or present). Therefore, the column will never grow larger than the largest text it contains or contained.

Parameters:

automaxwidth -

Since:

3.0.0.7

isMaxWidthAuto

boolean isMaxWidthAuto()

Retrieve whether the max width is automatically being set.

Returns:

max width auto setting state

Since:

3.0.0.7

setMinWidthAuto

void setMinWidthAuto(boolean autowidth)

Sets whether the min width of the column is automatically set. Depending on the UI, automatically setting the min width usually results in the column never shrinking below the maximum text width ever encountered.

Parameters:

autowidth -

Since:

3.0.0.7

isMinWidthAuto

boolean isMinWidthAuto()

Retrieve whether the min width is automatically being set

Returns:

min width auto setting state

Since:

3.0.0.7

setPreferredWidth

void setPreferredWidth(int width)

Sets the preferred width of the column. When the UI is in auto-expand mode and space is made available, the columns will first fill to their preferred width, then to their maximum width.

Parameters:

width - New preferred width

Since:

3.0.0.7

getPreferredWidth

int getPreferredWidth()

Gets the preferred width of the coloumn.

Returns:

preferred width

Since:

3.0.0.7

isPreferredWidthAuto

boolean isPreferredWidthAuto()

Retrieves whether the preferred width is automatically calculated.

Returns:

preferred width auto calculation state

Since:

3.0.0.7

setPreferredWidthAuto

void setPreferredWidthAuto(boolean auto)

Sets whether the preferred with is automatically calculated. An automatically calculated preferred width will be set to the largest text width known to that column

Parameters:

auto - Preferred Width Auto State

Since:

3.0.0.7

isVisible

boolean isVisible()

Gets the visibility of the column

Not all UIs may have this feature implemented.

Returns:

Column visibility

Since:

3.0.0.7

setUserData

void setUserData(java.lang.String key,
                 java.lang.Object value)

Associates custom data with the column, usually meant for column-specific settings and stores it across sessions

Parameters:

key - the key under which the value will be stored and serialized

value - should be BEncodable, otherwise it won't be serialized

removeUserData

void removeUserData(java.lang.String key)

postConfigLoad

void postConfigLoad()

implement this method if you want to be notified when the stored column configuration such as user data or GUI-adjustable properties have been loaded

preConfigSave

void preConfigSave()

implement this method if you want to be notified when the column configuration is about to be serialized

getUserData

java.lang.Object getUserData(java.lang.String key)

Parameters:

key -

Returns:

data set via setUserData()

setVisible

void setVisible(boolean visible)

Sets the visibility of the column

Parameters:

visible - New visibility state

Since:

3.0.0.7

addCellRefreshListener

void addCellRefreshListener(TableCellRefreshListener listener)

Adds a listener that triggers when a TableCell that belongs to this column needs refreshing.

Parameters:

listener - Listener Object to be called when refresh is needed.

Since:

2.1.0.0

removeCellRefreshListener

void removeCellRefreshListener(TableCellRefreshListener listener)

Removed a previously added TableCellRefreshListener

Parameters:

listener - Previously added listener

Since:

2.1.0.0

addCellAddedListener

void addCellAddedListener(TableCellAddedListener listener)

Adds a listener that triggers when a TableCell that belongs to this column is being added.

Parameters:

listener - Listener Object to be called when refresh is needed.

Since:

2.1.0.0

removeCellAddedListener

void removeCellAddedListener(TableCellAddedListener listener)

addCellDisposeListener

void addCellDisposeListener(TableCellDisposeListener listener)

Adds a listener that triggers when a TableCell that belongs to this column is being disposed.

Parameters:

listener - Listener Object to be called when refresh is needed.

Since:

2.1.0.0

removeCellDisposeListener

void removeCellDisposeListener(TableCellDisposeListener listener)

addCellToolTipListener

void addCellToolTipListener(TableCellToolTipListener listener)

Adds a listener that triggers when a TableCell that belongs to this column has a tooltip action

Parameters:

listener - Listener Object to be called when refresh is needed.

Since:

2.1.0.2

removeCellToolTipListener

void removeCellToolTipListener(TableCellToolTipListener listener)

addCellMouseListener

void addCellMouseListener(TableCellMouseListener listener)

Adds a listener that triggers when a TableCell that belongs to this column has a mouse event.

Parameters:

listener -

Since:

2.3.0.7

removeCellMouseListener

void removeCellMouseListener(TableCellMouseListener listener)

Remove a previously added TableCellMouseListener

Parameters:

listener - Previously added listener

Since:

2.3.0.7

addListeners

void addListeners(java.lang.Object listenerObject)

A listener is added for every type of cell listener the supplied object implements

Parameters:

listenerObject - Object implementing some cell listeneters

Since:

2.4.0.0

invalidateCells

void invalidateCells()

Invalidate all cells in this column. The cells will be forced to update on the next refresh.

Since:

2.1.0.0

invalidateCell

void invalidateCell(java.lang.Object data_source)

Invalidates any cells which are linked to the given data source object.

Since:

3.0.1.5

addContextMenuItem

TableContextMenuItem addContextMenuItem(java.lang.String resourceKey)

Adds a Context Menu item to the "This Column" sub menu

Parameters:

resourceKey - ID of the context menu, which is also used to retreieve the textual name from the plugin language file.

Returns:

a newly created menu item

Since:

2.4.0.0

isObfusticated

boolean isObfusticated()

Returns whether the column's data will be obfusticated when screen capturing (for bug reports, etc).

Currently not fully implemented for plugins

Returns:

Obfusticated value

Since:

2.4.0.3

setObfustication

void setObfustication(boolean hideData)

Sets whether the column's data will be obfusticated during a screen capture (for bug reports, etc).

Parameters:

hideData - new state of obfustication

Since:

2.4.0.3