Class TableColumnImpl
- All Implemented Interfaces:
TableColumn
,TableColumnCore
,Comparator<TableRowCore>
- Direct Known Subclasses:
CoreTableColumn
A column is defined in relation to a table. When one column is in multiple tables of different table ids, each table has it's own column instance
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private boolean
private int[]
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private ArrayList
<TableCellAddedListener> private ArrayList
<TableCellClipboardListener> private ArrayList
<TableCellDisposeListener> private TableCellInplaceEditorListener
private ArrayList
<TableCellMenuListener> private ArrayList
<TableCellMouseListener> private ArrayList
<TableCellMouseMoveListener> private ArrayList
<TableCellRefreshListener> private ArrayList
<TableCellToolTipListener> private ArrayList
<TableCellVisibilityListener> private static final String
private ArrayList
<TableColumnExtraInfoListener> private boolean
private int[]
private int
private String
private boolean
private int
private int
private int
private int
private int
private int
private static boolean
private static Comparator
<String> private int
private int
private int
private int
private boolean
private int
private int
private long
private long
private long
private long
private ArrayList
<TableContextMenuItem> private ArrayList
<TableContextMenuItem> private boolean
private boolean
private boolean
private String
Internal Name/ID of the columnprivate String
Table the column belongs toprivate String
key of the displayed title for the column.protected final AEMonitor
private static UIFunctions
private Map
Fields inherited from interface com.biglybt.pif.ui.tables.TableColumn
ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEAD, ALIGN_TOP, ALIGN_TRAIL, CAT_BYTES, CAT_CONNECTION, CAT_CONTENT, CAT_ESSENTIAL, CAT_PEER_IDENTIFICATION, CAT_PROGRESS, CAT_PROTOCOL, CAT_SETTINGS, CAT_SHARING, CAT_SWARM, CAT_TIME, CAT_TRACKER, INTERVAL_GRAPHIC, INTERVAL_INVALID_ONLY, INTERVAL_LIVE, MENU_STYLE_COLUMN_DATA, MENU_STYLE_HEADER, POSITION_INVISIBLE, POSITION_LAST, TYPE_GRAPHIC, TYPE_TEXT, TYPE_TEXT_ONLY, UD_FORCE_VISIBLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCellAddedListener
(TableCellAddedListener listener) Adds a listener that triggers when a TableCell that belongs to this column is being added.void
void
Adds a listener that triggers when a TableCell that belongs to this column is being disposed.void
addCellMenuListener
(TableCellMenuListener listener) void
addCellMouseListener
(TableCellMouseListener listener) Adds a listener that triggers when a TableCell that belongs to this column has a mouse event.void
void
addCellOtherListener
(String listenerID, Object listener) void
Adds a listener that triggers when a TableCell that belongs to this column needs refreshing.void
Adds a listener that triggers when a TableCell that belongs to this column has a tooltip actionvoid
void
addContextMenuItem
(String key) Adds a Context Menu item to data section of the columnaddContextMenuItem
(String key, int menuStyle) Adds a Context Menu item to the columnvoid
addDataSourceType
(Class<?> cla) void
addDataSourceTypes
(Class[] datasourceTypes) void
addListeners
(Object listenerObject) A listener is added for every type of cell listener the supplied object implementsvoid
addRefreshTime
(long ms) int
compare
(TableRowCore arg0, TableRowCore arg1) boolean
void
generateDiagnostics
(IndentWriter writer) int
Returns the alignment of the columnint[]
Retreive all the Cell Added listenersObject[]
getCellOtherListeners
(String listenerID) Retrieve all the refresh listeners for the cellgetClipboardText
(TableCell cell) boolean
Retrieve whether the column has been added to the TableColumnManagerint
getContextMenuItems
(int menuStyle) Class[]
int[]
boolean
long
private String
getListCountString
(List<?> l) int
Gets the maximum width the column can beint
Gets the minimum width that the column can be before other columns start collapsing.getName()
The logical name of the column.Returns the user's column name override if it existsint
Returns the position of the columnint
int
Gets the preferred width of the coloumn.int
int
Returns the refresh interval of the column.Which table the column will be visible in.Returns the key in the properties bundle that has the title of the column.getTitleLanguageKey
(boolean with_renames) int
getType()
Returns the type of the contained data.boolean
Retrieve whether a core or plugin object is sent via getDataSource()getUserData
(String key) getUserDataString
(String key) int
getWidth()
Returns the column's sizeboolean
handlesDataSourceType
(Class<?> cla) boolean
boolean
hasCellOtherListeners
(String listenerID) boolean
boolean
private void
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
(Object data_source) Invalidates any cells which are linked to the given data source object.void
Invalidate all cells in this column.void
Send a cellAdded trigger to all listeners stored in TableColumnvoid
Send a dispose trigger to all listeners stored in TableColumnvoid
void
Send a mouse event to the cell mouse listenersvoid
invokeCellRefreshListeners
(TableCell cell, boolean fastRefresh) Send a refresh trigger to all listeners stored in TableColumnvoid
invokeCellToolTipListeners
(TableCellCore cell, int type) Send a tool tip event to the tool tip listenersvoid
invokeCellVisibilityListeners
(TableCellCore cell, int visibility) Send a visibility event to the cell's visibility listenersboolean
isDirty()
boolean
boolean
Returns whether the column's data will be obfuscated when screen capturing (for bug reports, etc).boolean
Retrieves whether the preferred width is automatically calculated.boolean
boolean
boolean
boolean
Gets the visibility of the columnfinal void
loadSettings
(Map mapSettings) Load width and position settings from config.private void
void
implement this method if you want to be notified when the stored column configuration such as user data or GUI-adjustable properties have been loadedvoid
preAdd()
void
implement this method if you want to be notified when the column configuration is about to be serializedvoid
remove()
void
void
void
void
removeCellMenuListener
(TableCellMenuListener listener) void
Remove a previously added TableCellMouseListenervoid
void
removeCellOtherListener
(String listenerID, Object l) void
Removed a previously added TableCellRefreshListenervoid
void
void
void
removeContextMenuItem
(TableContextMenuItem menuItem) void
removeUserData
(String key) void
reset()
final void
saveSettings
(Map mapSettings) Save width and position settings to config.void
setAlignment
(int alignment) Orientation of the columns text and header.void
setAutoTooltip
(boolean auto_tooltip) void
setBackgroundColor
(int[] rgb) void
Set the internal flag specifying whether the column has been added to the TableColumnManager.void
setConsecutiveErrCount
(int iCount) void
setDefaultSortAscending
(boolean bAscending) void
setForegroundColor
(int[] rgb) void
setIconReference
(String iconID, boolean showOnlyIcon) void
setIconReferenceEnabled
(boolean b) void
void
setLastSortValueChange
(long lastSortValueChange) void
setMaxWidth
(int maxwidth) Sets the maximum width that the column can bevoid
setMinimumRequiredUserMode
(int mode) *since 4501void
setMinWidth
(int minwidth) Sets the minimum width that the column can be before other columns start collapsing.void
setNameOverride
(String name) void
setObfuscation
(boolean hideData) Sets whether the column's data will be obfuscated during a screen capture (for bug reports, etc).void
setPosition
(int position) Location to put the column.void
setPositionNoShift
(int position) Sets the position of the column without adjusting the other columns.void
setPreferredHeaderWidth
(int width) void
setPreferredWidth
(int width) Sets the preferred width of the column.void
setPreferredWidthAuto
(boolean auto) Sets whether the preferred with is automatically calculated.void
setPreferredWidthMax
(int maxprefwidth) void
setRefreshInterval
(int interval) Set how often the cell receives a refresh() triggervoid
setSortAscending
(boolean bAscending) void
setSortValueLive
(boolean live) void
setTableID
(String tableID) void
setType
(int type) The type of the contained data.
Current supported types are long, string, and graphic.void
setUseCoreDataSource
(boolean bCoreDataSource) Changes whatinvalid @link
{@link TableCellCore.getDataSource()
invalid @link
{@link TableRowCore.getDataSource()
void
setUserData
(String key, Object value) Associates custom data with the column, usually meant for column-specific settings and stores it across sessionsvoid
setVisible
(boolean visible) Sets the visibility of the columnvoid
setWidth
(int realPXWidth) The column size.void
setWidthLimits
(int min, int max) Sets the minimum and maximum widths in one callvoid
setWidthPX
(int width) boolean
void
triggerColumnSizeChange
(int diff) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Field Details
-
CFG_SORTDIRECTION
- See Also:
-
ATTRIBUTE_NAME_OVERIDE
- See Also:
-
uiFunctions
-
intuitiveComparator
-
intiutiveSorting
private static boolean intiutiveSorting -
sName
Internal Name/ID of the column -
sTitleLanguageKey
key of the displayed title for the column. If null, uses default calc -
iAlignment
private int iAlignment -
iDefaultAlignment
private int iDefaultAlignment -
iType
private int iType -
iPosition
private int iPosition -
iWidth
private int iWidth -
iDefaultWidth
private int iDefaultWidth -
iInterval
private int iInterval -
lLastSortValueChange
private long lLastSortValueChange -
foregroundColor
private int[] foregroundColor -
backgroundColor
private int[] backgroundColor -
sTableID
Table the column belongs to -
bColumnAdded
private boolean bColumnAdded -
bCoreDataSource
private boolean bCoreDataSource -
cellEditorListener
-
cellRefreshListeners
-
cellAddedListeners
-
cellDisposeListeners
-
cellToolTipListeners
-
cellMouseListeners
-
cellMenuListeners
-
cellMouseMoveListeners
-
cellVisibilityListeners
-
cellClipboardListeners
-
columnExtraInfoListeners
-
mapOtherCellListeners
-
iConsecutiveErrCount
private int iConsecutiveErrCount -
bObfuscateData
private boolean bObfuscateData -
this_mon
-
bSortValueLive
private boolean bSortValueLive -
lStatsRefreshTotalTime
private long lStatsRefreshTotalTime -
lStatsRefreshCount
private long lStatsRefreshCount -
lStatsRefreshZeroCount
private long lStatsRefreshZeroCount -
bSortAscending
private boolean bSortAscending -
bDefaultSortAscending
private boolean bDefaultSortAscending -
iMinWidth
private int iMinWidth -
iMaxWidth
private int iMaxWidth -
bVisible
private boolean bVisible -
iPreferredWidth
private int iPreferredWidth -
bPreferredWidthAuto
private boolean bPreferredWidthAuto -
iPreferredWidthMax
private int iPreferredWidthMax -
iPreferredHeaderWidth
private int iPreferredHeaderWidth -
auto_tooltip
private boolean auto_tooltip -
userData
-
removed
private boolean removed -
forPluginDataSourceTypes
-
iconID
-
iconIDEnabled
private boolean iconIDEnabled -
firstLoad
private boolean firstLoad -
showOnlyImage
private boolean showOnlyImage -
postLoadConfig
private boolean postLoadConfig -
isDirty
private boolean isDirty
-
-
Constructor Details
-
TableColumnImpl
-
-
Method Details
-
init
-
initialize
public void initialize(int iAlignment, int iPosition, int iWidth, int iInterval) Description copied from interface:TableColumn
Initialize a group of variables all at once. Saves on individual setXxx.- Specified by:
initialize
in interfaceTableColumn
- Parameters:
iAlignment
- SeeTableColumn.setAlignment(int)
iPosition
- SeeTableColumn.setPosition(int)
iWidth
- SeeTableColumn.setWidth(int)
iInterval
- SeeTableColumn.setRefreshInterval(int)
-
initialize
public void initialize(int iAlignment, int iPosition, int iWidth) Description copied from interface:TableColumn
Initialize a group of variables all at once. Saves on individual setXxx.- Specified by:
initialize
in interfaceTableColumn
- Parameters:
iAlignment
- SeeTableColumn.setAlignment(int)
iPosition
- SeeTableColumn.setPosition(int)
iWidth
- SeeTableColumn.setWidth(int)
-
getName
Description copied from interface:TableColumn
The logical name of the column. This was set viaTableManager.createColumn(java.lang.String, java.lang.String)
and can not be changed.- Specified by:
getName
in interfaceTableColumn
- Returns:
- the column name (identification)
-
getNameOverride
Description copied from interface:TableColumn
Returns the user's column name override if it exists- Specified by:
getNameOverride
in interfaceTableColumn
- Returns:
-
setNameOverride
- Specified by:
setNameOverride
in interfaceTableColumn
-
getTableID
Description copied from interface:TableColumn
Which table the column will be visible in. This was set viaTableManager.createColumn(java.lang.String, java.lang.String)
and can not be changed.- Specified by:
getTableID
in interfaceTableColumn
- Returns:
TableManager
.TABLE_* constant(s)
-
setType
public void setType(int type) Description copied from interface:TableColumn
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 isTableColumn.TYPE_TEXT_ONLY
.- Specified by:
setType
in interfaceTableColumn
- Parameters:
type
-TableColumn.TYPE_TEXT
,TableColumn.TYPE_TEXT_ONLY
,TableColumn.TYPE_GRAPHIC
-
getType
public int getType()Description copied from interface:TableColumn
Returns the type of the contained data.- Specified by:
getType
in interfaceTableColumn
- Returns:
- type TYPE_TEXT, or TYPE_GRAPHIC
-
setWidth
public void setWidth(int realPXWidth) Description copied from interface:TableColumn
The column size.NOTE: This MUST be set BEFORE adding the column to a table.
- Specified by:
setWidth
in interfaceTableColumn
-
setWidthPX
public void setWidthPX(int width) - Specified by:
setWidthPX
in interfaceTableColumn
-
triggerColumnSizeChange
public void triggerColumnSizeChange(int diff) - Specified by:
triggerColumnSizeChange
in interfaceTableColumnCore
-
getWidth
public int getWidth()Description copied from interface:TableColumn
Returns the column's size- Specified by:
getWidth
in interfaceTableColumn
- Returns:
- width in pixels
-
setPosition
public void setPosition(int position) Description copied from interface:TableColumn
Location to put the column. When set before being added to the UI (seeTableManager.addColumn(com.biglybt.pif.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.- Specified by:
setPosition
in interfaceTableColumn
- Parameters:
position
- Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST
-
getPosition
public int getPosition()Description copied from interface:TableColumn
Returns the position of the column- Specified by:
getPosition
in interfaceTableColumn
- Returns:
- Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST
-
setAlignment
public void setAlignment(int alignment) Description copied from interface:TableColumn
Orientation of the columns text and header.NOTE: This MUST be set BEFORE adding the column to a table.
- Specified by:
setAlignment
in interfaceTableColumn
- Parameters:
alignment
- ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER
-
getAlignment
public int getAlignment()Description copied from interface:TableColumn
Returns the alignment of the column- Specified by:
getAlignment
in interfaceTableColumn
- Returns:
- ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER
-
getForegroundColor
public int[] getForegroundColor()- Specified by:
getForegroundColor
in interfaceTableColumnCore
-
setForegroundColor
public void setForegroundColor(int[] rgb) - Specified by:
setForegroundColor
in interfaceTableColumnCore
-
getBackgroundColor
public int[] getBackgroundColor()- Specified by:
getBackgroundColor
in interfaceTableColumnCore
-
setBackgroundColor
public void setBackgroundColor(int[] rgb) - Specified by:
setBackgroundColor
in interfaceTableColumnCore
-
addCellRefreshListener
Description copied from interface:TableColumn
Adds a listener that triggers when a TableCell that belongs to this column needs refreshing.- Specified by:
addCellRefreshListener
in interfaceTableColumn
- Parameters:
listener
- Listener Object to be called when refresh is needed.
-
getCellRefreshListeners
Description copied from interface:TableColumnCore
Retrieve all the refresh listeners for the cell- Specified by:
getCellRefreshListeners
in interfaceTableColumnCore
- Returns:
- Cell refresh listeners
-
removeCellRefreshListener
Description copied from interface:TableColumn
Removed a previously added TableCellRefreshListener- Specified by:
removeCellRefreshListener
in interfaceTableColumn
- Parameters:
listener
- Previously added listener
-
hasCellRefreshListener
public boolean hasCellRefreshListener()- Specified by:
hasCellRefreshListener
in interfaceTableColumnCore
- Returns:
-
setRefreshInterval
public void setRefreshInterval(int interval) Description copied from interface:TableColumn
Set how often the cell receives a refresh() trigger- Specified by:
setRefreshInterval
in interfaceTableColumn
- 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"
-
getRefreshInterval
public int getRefreshInterval()Description copied from interface:TableColumn
Returns the refresh interval of the column. The default is INTERVAL_INVALID_ONLY- Specified by:
getRefreshInterval
in interfaceTableColumn
- Returns:
- INTERVAL_* constant, or a number representing the # of GUI refresh cycles between each cell refresh call.
-
addCellAddedListener
Description copied from interface:TableColumn
Adds a listener that triggers when a TableCell that belongs to this column is being added.- Specified by:
addCellAddedListener
in interfaceTableColumn
- Parameters:
listener
- Listener Object to be called when refresh is needed.
-
addCellOtherListener
- Specified by:
addCellOtherListener
in interfaceTableColumnCore
- Parameters:
listenerID
-listener
-
-
removeCellOtherListener
- Specified by:
removeCellOtherListener
in interfaceTableColumnCore
-
getCellOtherListeners
- Specified by:
getCellOtherListeners
in interfaceTableColumnCore
- Parameters:
listenerID
-- Returns:
-
hasCellOtherListeners
- Specified by:
hasCellOtherListeners
in interfaceTableColumnCore
- Parameters:
listenerID
-- Returns:
-
getCellAddedListeners
Description copied from interface:TableColumnCore
Retreive all the Cell Added listeners- Specified by:
getCellAddedListeners
in interfaceTableColumnCore
- Returns:
- cell added listeners for this cell
-
removeCellAddedListener
- Specified by:
removeCellAddedListener
in interfaceTableColumn
-
addCellDisposeListener
Description copied from interface:TableColumn
Adds a listener that triggers when a TableCell that belongs to this column is being disposed.- Specified by:
addCellDisposeListener
in interfaceTableColumn
- Parameters:
listener
- Listener Object to be called when refresh is needed.
-
removeCellDisposeListener
- Specified by:
removeCellDisposeListener
in interfaceTableColumn
-
addCellToolTipListener
Description copied from interface:TableColumn
Adds a listener that triggers when a TableCell that belongs to this column has a tooltip action- Specified by:
addCellToolTipListener
in interfaceTableColumn
- Parameters:
listener
- Listener Object to be called when refresh is needed.
-
removeCellToolTipListener
- Specified by:
removeCellToolTipListener
in interfaceTableColumn
-
addCellMouseListener
Description copied from interface:TableColumn
Adds a listener that triggers when a TableCell that belongs to this column has a mouse event.- Specified by:
addCellMouseListener
in interfaceTableColumn
- Parameters:
listener
-
-
removeCellMouseListener
Description copied from interface:TableColumn
Remove a previously added TableCellMouseListener- Specified by:
removeCellMouseListener
in interfaceTableColumn
- Parameters:
listener
- Previously added listener
-
addCellMenuListener
- Specified by:
addCellMenuListener
in interfaceTableColumn
-
removeCellMenuListener
- Specified by:
removeCellMenuListener
in interfaceTableColumn
-
hasCellMouseMoveListener
public boolean hasCellMouseMoveListener()- Specified by:
hasCellMouseMoveListener
in interfaceTableColumnCore
- Returns:
-
addCellMouseMoveListener
-
removeCellMouseMoveListener
-
addCellClipboardListener
-
removeCellClipboardListener
-
addCellVisibilityListener
-
removeCellVisibilityListener
-
getColumnExtraInfoListeners
- Specified by:
getColumnExtraInfoListeners
in interfaceTableColumnCore
- Returns:
-
addColumnExtraInfoListener
- Specified by:
addColumnExtraInfoListener
in interfaceTableColumn
- Parameters:
listener
-
-
removeColumnExtraInfoListener
- Specified by:
removeColumnExtraInfoListener
in interfaceTableColumn
- Parameters:
listener
-
-
invalidateCells
public void invalidateCells()Description copied from interface:TableColumn
Invalidate all cells in this column. The cells will be forced to update on the next refresh.- Specified by:
invalidateCells
in interfaceTableColumn
-
invalidateCell
Description copied from interface:TableColumn
Invalidates any cells which are linked to the given data source object.- Specified by:
invalidateCell
in interfaceTableColumn
-
addListeners
Description copied from interface:TableColumn
A listener is added for every type of cell listener the supplied object implements- Specified by:
addListeners
in interfaceTableColumn
- Parameters:
listenerObject
- Object implementing some cell listeneters
-
setColumnAdded
public void setColumnAdded()Description copied from interface:TableColumnCore
Set the internal flag specifying whether the column has been added to the TableColumnManager. Some functions can not be run after a column has been added.- Specified by:
setColumnAdded
in interfaceTableColumnCore
-
getColumnAdded
public boolean getColumnAdded()Description copied from interface:TableColumnCore
Retrieve whether the column has been added to the TableColumnManager- Specified by:
getColumnAdded
in interfaceTableColumnCore
- Returns:
- true - Column has been added
false - Column has not been added
-
setUseCoreDataSource
public void setUseCoreDataSource(boolean bCoreDataSource) Description copied from interface:TableColumnCore
Changes whatinvalid @link
{@link TableCellCore.getDataSource()
invalid @link
{@link TableRowCore.getDataSource()
- Specified by:
setUseCoreDataSource
in interfaceTableColumnCore
- Parameters:
bCoreDataSource
- true - returns a core object
false - returns a plugin object (if available)
-
getUseCoreDataSource
public boolean getUseCoreDataSource()Description copied from interface:TableColumnCore
Retrieve whether a core or plugin object is sent via getDataSource()- Specified by:
getUseCoreDataSource
in interfaceTableColumnCore
- Returns:
- true - returns a core object
false - returns a plugin object (if available)
-
invokeCellRefreshListeners
Description copied from interface:TableColumnCore
Send a refresh trigger to all listeners stored in TableColumn- Specified by:
invokeCellRefreshListeners
in interfaceTableColumnCore
- Parameters:
cell
- the cell is being refreshed- Throws:
Throwable
-
invokeCellAddedListeners
Description copied from interface:TableColumnCore
Send a cellAdded trigger to all listeners stored in TableColumn- Specified by:
invokeCellAddedListeners
in interfaceTableColumnCore
- Parameters:
cell
- the cell is being added
-
invokeCellDisposeListeners
Description copied from interface:TableColumnCore
Send a dispose trigger to all listeners stored in TableColumn- Specified by:
invokeCellDisposeListeners
in interfaceTableColumnCore
- Parameters:
cell
- the cell is being disposed
-
getClipboardText
- Specified by:
getClipboardText
in interfaceTableColumnCore
-
invokeCellToolTipListeners
Description copied from interface:TableColumnCore
Send a tool tip event to the tool tip listeners- Specified by:
invokeCellToolTipListeners
in interfaceTableColumnCore
- Parameters:
cell
- Cell to get the tool tip eventtype
-
-
invokeCellMouseListeners
Description copied from interface:TableColumnCore
Send a mouse event to the cell mouse listeners- Specified by:
invokeCellMouseListeners
in interfaceTableColumnCore
- Parameters:
event
- Mouse Event to send
-
invokeCellMenuListeners
- Specified by:
invokeCellMenuListeners
in interfaceTableColumnCore
-
invokeCellVisibilityListeners
Description copied from interface:TableColumnCore
Send a visibility event to the cell's visibility listeners- Specified by:
invokeCellVisibilityListeners
in interfaceTableColumnCore
- Parameters:
visibility
- Visibility state
-
setPositionNoShift
public void setPositionNoShift(int position) Description copied from interface:TableColumnCore
Sets the position of the column without adjusting the other columns. This will cause duplicate columns, and is only useful if you are adjusting the positions of multiple columns at once.- Specified by:
setPositionNoShift
in interfaceTableColumnCore
- Parameters:
position
- new position (0 based)
-
getUserData
- Specified by:
getUserData
in interfaceTableColumn
- Parameters:
key
-- Returns:
- data set via setUserData()
-
getUserDataString
- Specified by:
getUserDataString
in interfaceTableColumn
-
setUserData
Description copied from interface:TableColumn
Associates custom data with the column, usually meant for column-specific settings and stores it across sessions- Specified by:
setUserData
in interfaceTableColumn
- Parameters:
key
- the key under which the value will be stored and serializedvalue
- should be BEncodable, otherwise it won't be serialized
-
removeUserData
- Specified by:
removeUserData
in interfaceTableColumn
-
remove
public void remove()- Specified by:
remove
in interfaceTableColumn
-
isRemoved
public boolean isRemoved()- Specified by:
isRemoved
in interfaceTableColumnCore
- Returns:
-
loadSettings
Description copied from interface:TableColumnCore
Load width and position settings from config.- Specified by:
loadSettings
in interfaceTableColumnCore
- Parameters:
mapSettings
- map to place settings into
-
isFirstLoad
public boolean isFirstLoad() -
postConfigLoad
public void postConfigLoad()Description copied from interface:TableColumn
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- Specified by:
postConfigLoad
in interfaceTableColumn
-
preAdd
public void preAdd() -
preConfigSave
public void preConfigSave()Description copied from interface:TableColumn
implement this method if you want to be notified when the column configuration is about to be serialized- Specified by:
preConfigSave
in interfaceTableColumn
-
saveSettings
Description copied from interface:TableColumnCore
Save width and position settings to config.- Specified by:
saveSettings
in interfaceTableColumnCore
- Parameters:
mapSettings
- map to place settings into
-
getTitleLanguageKey
Description copied from interface:TableColumnCore
Returns the key in the properties bundle that has the title of the column.- Specified by:
getTitleLanguageKey
in interfaceTableColumnCore
- Returns:
- Title's language key
-
getTitleLanguageKey
- Specified by:
getTitleLanguageKey
in interfaceTableColumnCore
-
getConsecutiveErrCount
public int getConsecutiveErrCount()- Specified by:
getConsecutiveErrCount
in interfaceTableColumnCore
- Returns:
- # of consecutive errors
-
setConsecutiveErrCount
public void setConsecutiveErrCount(int iCount) - Specified by:
setConsecutiveErrCount
in interfaceTableColumnCore
- Parameters:
iCount
- # of consecutive errors
-
removeContextMenuItem
- Specified by:
removeContextMenuItem
in interfaceTableColumnCore
- Parameters:
menuItem
-
-
addContextMenuItem
Description copied from interface:TableColumn
Adds a Context Menu item to data section of the column- Specified by:
addContextMenuItem
in interfaceTableColumn
- Parameters:
key
- 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
-
addContextMenuItem
Description copied from interface:TableColumn
Adds a Context Menu item to the column- Specified by:
addContextMenuItem
in interfaceTableColumn
- Parameters:
key
- ID of the context menu, which is also used to retreieve the textual name from the plugin language file.menuStyle
- See MENU_STYLE_* constants (header or data)- Returns:
- a newly created menu item
-
getContextMenuItems
- Specified by:
getContextMenuItems
in interfaceTableColumnCore
- Returns:
-
isObfuscated
public boolean isObfuscated()Description copied from interface:TableColumn
Returns whether the column's data will be obfuscated when screen capturing (for bug reports, etc).Currently not fully implemented for plugins
- Specified by:
isObfuscated
in interfaceTableColumn
- Returns:
- Obfuscated value
-
setObfuscation
public void setObfuscation(boolean hideData) Description copied from interface:TableColumn
Sets whether the column's data will be obfuscated during a screen capture (for bug reports, etc).- Specified by:
setObfuscation
in interfaceTableColumn
- Parameters:
hideData
- new state of obfuscation
-
getLastSortValueChange
public long getLastSortValueChange()- Specified by:
getLastSortValueChange
in interfaceTableColumnCore
- Returns:
-
setLastSortValueChange
public void setLastSortValueChange(long lastSortValueChange) - Specified by:
setLastSortValueChange
in interfaceTableColumnCore
- Parameters:
lastSortValueChange
-
-
isSortValueLive
public boolean isSortValueLive()- Specified by:
isSortValueLive
in interfaceTableColumnCore
- Returns:
-
setSortValueLive
public void setSortValueLive(boolean live) - Specified by:
setSortValueLive
in interfaceTableColumnCore
- Parameters:
live
-
-
addRefreshTime
public void addRefreshTime(long ms) - Specified by:
addRefreshTime
in interfaceTableColumnCore
- Parameters:
ms
-
-
generateDiagnostics
- Specified by:
generateDiagnostics
in interfaceTableColumnCore
- Parameters:
writer
-
-
getListCountString
-
setTableID
- Specified by:
setTableID
in interfaceTableColumnCore
- Parameters:
tableID
-
-
compare
- Specified by:
compare
in interfaceComparator<TableRowCore>
- See Also:
-
setSortAscending
public void setSortAscending(boolean bAscending) - Specified by:
setSortAscending
in interfaceTableColumnCore
- Parameters:
bAscending
- The bAscending to set.
-
isSortAscending
public boolean isSortAscending()- Specified by:
isSortAscending
in interfaceTableColumnCore
- Returns:
- Returns the bAscending.
-
setDefaultSortAscending
public void setDefaultSortAscending(boolean bAscending) - Specified by:
setDefaultSortAscending
in interfaceTableColumnCore
- Parameters:
bAscending
-
-
getMinWidth
public int getMinWidth()Description copied from interface:TableColumn
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.
- Specified by:
getMinWidth
in interfaceTableColumn
- Returns:
- minumum width of the column
-
setMinWidth
public void setMinWidth(int minwidth) Description copied from interface:TableColumn
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.
- Specified by:
setMinWidth
in interfaceTableColumn
- Parameters:
minwidth
- new minumum width
-
getMaxWidth
public int getMaxWidth()Description copied from interface:TableColumn
Gets the maximum width the column can beNot all UIs may have this feature implemented.
- Specified by:
getMaxWidth
in interfaceTableColumn
- Returns:
- maximum width of column
-
setMaxWidth
public void setMaxWidth(int maxwidth) Description copied from interface:TableColumn
Sets the maximum width that the column can beNot all UIs may have this feature implemented.
- Specified by:
setMaxWidth
in interfaceTableColumn
- Parameters:
maxwidth
- new maximum width
-
setWidthLimits
public void setWidthLimits(int min, int max) Description copied from interface:TableColumn
Sets the minimum and maximum widths in one callNot all UIs may have this min and max limits implemented.
- Specified by:
setWidthLimits
in interfaceTableColumn
- Parameters:
min
- New minimum column widthmax
- New maximum column width
-
isVisible
public boolean isVisible()Description copied from interface:TableColumn
Gets the visibility of the columnNot all UIs may have this feature implemented.
- Specified by:
isVisible
in interfaceTableColumn
- Returns:
- Column visibility
-
setVisible
public void setVisible(boolean visible) Description copied from interface:TableColumn
Sets the visibility of the column- Specified by:
setVisible
in interfaceTableColumn
- Parameters:
visible
- New visibility state
-
getPreferredWidth
public int getPreferredWidth()Description copied from interface:TableColumn
Gets the preferred width of the coloumn.- Specified by:
getPreferredWidth
in interfaceTableColumn
- Returns:
- preferred width
-
setPreferredWidthAuto
public void setPreferredWidthAuto(boolean auto) Description copied from interface:TableColumn
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- Specified by:
setPreferredWidthAuto
in interfaceTableColumn
- Parameters:
auto
- Preferred Width Auto State
-
isPreferredWidthAuto
public boolean isPreferredWidthAuto()Description copied from interface:TableColumn
Retrieves whether the preferred width is automatically calculated.- Specified by:
isPreferredWidthAuto
in interfaceTableColumn
- Returns:
- preferred width auto calculation state
-
setPreferredWidthMax
public void setPreferredWidthMax(int maxprefwidth) -
getPreferredWidthMax
public int getPreferredWidthMax() -
setPreferredWidth
public void setPreferredWidth(int width) Description copied from interface:TableColumn
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.- Specified by:
setPreferredWidth
in interfaceTableColumn
- Parameters:
width
- New preferred width
-
getPreferredHeaderWidth
public int getPreferredHeaderWidth()- Specified by:
getPreferredHeaderWidth
in interfaceTableColumnCore
-
setPreferredHeaderWidth
public void setPreferredHeaderWidth(int width) - Specified by:
setPreferredHeaderWidth
in interfaceTableColumnCore
-
setAutoTooltip
public void setAutoTooltip(boolean auto_tooltip) - Specified by:
setAutoTooltip
in interfaceTableColumnCore
-
doesAutoTooltip
public boolean doesAutoTooltip()- Specified by:
doesAutoTooltip
in interfaceTableColumnCore
-
setInplaceEditorListener
- Specified by:
setInplaceEditorListener
in interfaceTableColumnCore
-
hasInplaceEditorListener
public boolean hasInplaceEditorListener()- Specified by:
hasInplaceEditorListener
in interfaceTableColumnCore
-
getInplaceEditorListener
- Specified by:
getInplaceEditorListener
in interfaceTableColumnCore
-
getForDataSourceTypes
-
reset
public void reset()- Specified by:
reset
in interfaceTableColumnCore
-
addDataSourceType
- Specified by:
addDataSourceType
in interfaceTableColumnCore
- Parameters:
cla
-
-
addDataSourceTypes
-
handlesDataSourceType
- Specified by:
handlesDataSourceType
in interfaceTableColumnCore
-
getForDataSourceType
- Specified by:
getForDataSourceType
in interfaceTableColumn
- Returns:
-
setIconReference
- Specified by:
setIconReference
in interfaceTableColumn
-
getIconReference
- Specified by:
getIconReference
in interfaceTableColumn
-
setIconReferenceEnabled
public void setIconReferenceEnabled(boolean b) - Specified by:
setIconReferenceEnabled
in interfaceTableColumn
-
getIconReferenceEnabled
public boolean getIconReferenceEnabled()- Specified by:
getIconReferenceEnabled
in interfaceTableColumn
-
setMinimumRequiredUserMode
public void setMinimumRequiredUserMode(int mode) Description copied from interface:TableColumn
*since 4501- Specified by:
setMinimumRequiredUserMode
in interfaceTableColumn
- Parameters:
mode
- from Parameter. constants
-
showOnlyImage
public boolean showOnlyImage()- Specified by:
showOnlyImage
in interfaceTableColumnCore
-
markDirty
private void markDirty() -
isDirty
public boolean isDirty()- Specified by:
isDirty
in interfaceTableColumnCore
-