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 Stringprivate booleanprivate int[]private booleanprivate booleanprivate booleanprivate booleanprivate booleanprivate booleanprivate booleanprivate booleanprivate ArrayList<TableCellAddedListener> private ArrayList<TableCellClipboardListener> private ArrayList<TableCellDisposeListener> private TableCellInplaceEditorListenerprivate ArrayList<TableCellMenuListener> private ArrayList<TableCellMouseListener> private ArrayList<TableCellMouseMoveListener> private ArrayList<TableCellRefreshListener> private ArrayList<TableCellToolTipListener> private ArrayList<TableCellVisibilityListener> private static final Stringprivate ArrayList<TableColumnExtraInfoListener> private booleanprivate int[]private intprivate Stringprivate booleanprivate intprivate intprivate intprivate intprivate intprivate intprivate static booleanprivate static Comparator<String> private intprivate intprivate intprivate intprivate booleanprivate intprivate intprivate longprivate longprivate longprivate longprivate ArrayList<TableContextMenuItem> private ArrayList<TableContextMenuItem> private booleanprivate booleanprivate booleanprivate StringInternal Name/ID of the columnprivate StringTable the column belongs toprivate Stringkey of the displayed title for the column.protected final AEMonitorprivate static UIFunctionsprivate MapFields inherited from interface 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 TypeMethodDescriptionvoidaddCellAddedListener(TableCellAddedListener listener) Adds a listener that triggers when a TableCell that belongs to this column is being added.voidvoidAdds a listener that triggers when a TableCell that belongs to this column is being disposed.voidaddCellMenuListener(TableCellMenuListener listener) voidaddCellMouseListener(TableCellMouseListener listener) Adds a listener that triggers when a TableCell that belongs to this column has a mouse event.voidvoidaddCellOtherListener(String listenerID, Object listener) voidAdds a listener that triggers when a TableCell that belongs to this column needs refreshing.voidAdds a listener that triggers when a TableCell that belongs to this column has a tooltip actionvoidvoidaddContextMenuItem(String key) Adds a Context Menu item to data section of the columnaddContextMenuItem(String key, int menuStyle) Adds a Context Menu item to the columnvoidaddDataSourceType(Class<?> cla) voidaddDataSourceTypes(Class[] datasourceTypes) voidaddListeners(Object listenerObject) A listener is added for every type of cell listener the supplied object implementsvoidaddRefreshTime(long ms) intcompare(TableRowCore arg0, TableRowCore arg1) booleanvoidgenerateDiagnostics(IndentWriter writer) intReturns the alignment of the columnint[]Retreive all the Cell Added listenersObject[]getCellOtherListeners(String listenerID) Retrieve all the refresh listeners for the cellgetClipboardText(TableCell cell) booleanRetrieve whether the column has been added to the TableColumnManagerintgetContextMenuItems(int menuStyle) Class[]int[]booleanlongprivate StringgetListCountString(List<?> l) intGets the maximum width the column can beintGets 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 existsintReturns the position of the columnintintGets the preferred width of the coloumn.intintReturns 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) intgetType()Returns the type of the contained data.booleanRetrieve whether a core or plugin object is sent via getDataSource()getUserData(String key) getUserDataString(String key) intgetWidth()Returns the column's sizebooleanhandlesDataSourceType(Class<?> cla) booleanbooleanhasCellOtherListeners(String listenerID) booleanbooleanprivate voidvoidinitialize(int iAlignment, int iPosition, int iWidth) Initialize a group of variables all at once.voidinitialize(int iAlignment, int iPosition, int iWidth, int iInterval) Initialize a group of variables all at once.voidinvalidateCell(Object data_source) Invalidates any cells which are linked to the given data source object.voidInvalidate all cells in this column.voidSend a cellAdded trigger to all listeners stored in TableColumnvoidSend a dispose trigger to all listeners stored in TableColumnvoidvoidSend a mouse event to the cell mouse listenersvoidinvokeCellRefreshListeners(TableCell cell, boolean fastRefresh) Send a refresh trigger to all listeners stored in TableColumnvoidinvokeCellToolTipListeners(TableCellCore cell, int type) Send a tool tip event to the tool tip listenersvoidinvokeCellVisibilityListeners(TableCellCore cell, int visibility) Send a visibility event to the cell's visibility listenersbooleanisDirty()booleanbooleanReturns whether the column's data will be obfuscated when screen capturing (for bug reports, etc).booleanRetrieves whether the preferred width is automatically calculated.booleanbooleanbooleanbooleanGets the visibility of the columnfinal voidloadSettings(Map mapSettings) Load width and position settings from config.private voidvoidimplement this method if you want to be notified when the stored column configuration such as user data or GUI-adjustable properties have been loadedvoidpreAdd()voidimplement this method if you want to be notified when the column configuration is about to be serializedvoidremove()voidvoidvoidvoidremoveCellMenuListener(TableCellMenuListener listener) voidRemove a previously added TableCellMouseListenervoidvoidremoveCellOtherListener(String listenerID, Object l) voidRemoved a previously added TableCellRefreshListenervoidvoidvoidvoidremoveContextMenuItem(TableContextMenuItem menuItem) voidremoveUserData(String key) voidreset()voidreset(boolean width, boolean align, boolean fg, boolean bg) final voidsaveSettings(Map mapSettings) Save width and position settings to config.voidsetAlignment(int alignment) Orientation of the columns text and header.voidsetAutoTooltip(boolean auto_tooltip) voidsetBackgroundColor(int[] rgb) void///////////////////////////////////////////voidsetConsecutiveErrCount(int iCount) voidsetDefaultSortAscending(boolean bAscending) voidsetForegroundColor(int[] rgb) voidsetIconReference(String iconID, boolean showOnlyIcon) voidsetIconReferenceEnabled(boolean b) voidvoidsetLastSortValueChange(long lastSortValueChange) voidsetMaxWidth(int maxwidth) Sets the maximum width that the column can bevoidsetMinimumRequiredUserMode(int mode) *since 4501voidsetMinWidth(int minwidth) Sets the minimum width that the column can be before other columns start collapsing.voidsetNameOverride(String name) voidsetObfuscation(boolean hideData) Sets whether the column's data will be obfuscated during a screen capture (for bug reports, etc).voidsetPosition(int position) Location to put the column.voidsetPositionNoShift(int position) Sets the position of the column without adjusting the other columns.voidsetPreferredHeaderWidth(int width) voidsetPreferredWidth(int width) Sets the preferred width of the column.voidsetPreferredWidthAuto(boolean auto) Sets whether the preferred with is automatically calculated.voidsetPreferredWidthMax(int maxprefwidth) voidsetRefreshInterval(int interval) Set how often the cell receives a refresh() triggervoidsetSortAscending(boolean bAscending) voidsetSortValueLive(boolean live) voidsetTableID(String tableID) voidsetType(int type) The type of the contained data.
Current supported types are long, string, and graphic.voidsetUseCoreDataSource(boolean bCoreDataSource) Changes what} andinvalid @link
{@link TableCellCore.getDataSource()} return.invalid @link
{@link TableRowCore.getDataSource()voidsetUserData(String key, Object value) Associates custom data with the column, usually meant for column-specific settings and stores it across sessionsvoidsetVisible(boolean visible) Sets the visibility of the columnvoidsetWidth(int realPXWidth) The column size.voidsetWidthLimits(int min, int max) Sets the minimum and maximum widths in one callvoidsetWidthPX(int width) booleanvoidtriggerColumnSizeChange(int diff) Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface 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:TableColumnInitialize a group of variables all at once. Saves on individual setXxx.- Specified by:
initializein 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:TableColumnInitialize a group of variables all at once. Saves on individual setXxx.- Specified by:
initializein interfaceTableColumn- Parameters:
iAlignment- SeeTableColumn.setAlignment(int)iPosition- SeeTableColumn.setPosition(int)iWidth- SeeTableColumn.setWidth(int)
-
getName
Description copied from interface:TableColumnThe logical name of the column. This was set viaTableManager.createColumn(String, String)and can not be changed.- Specified by:
getNamein interfaceTableColumn- Returns:
- the column name (identification)
-
getNameOverride
Description copied from interface:TableColumnReturns the user's column name override if it exists- Specified by:
getNameOverridein interfaceTableColumn- Returns:
-
setNameOverride
- Specified by:
setNameOverridein interfaceTableColumn
-
getTableID
Description copied from interface:TableColumnWhich table the column will be visible in. This was set viaTableManager.createColumn(String, String)and can not be changed.- Specified by:
getTableIDin interfaceTableColumn- Returns:
TableManager.TABLE_* constant(s)
-
setType
public void setType(int type) Description copied from interface:TableColumnThe 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:
setTypein interfaceTableColumn- Parameters:
type-TableColumn.TYPE_TEXT,TableColumn.TYPE_TEXT_ONLY,TableColumn.TYPE_GRAPHIC
-
getType
public int getType()Description copied from interface:TableColumnReturns the type of the contained data.- Specified by:
getTypein interfaceTableColumn- Returns:
- type TYPE_TEXT, or TYPE_GRAPHIC
-
setWidth
public void setWidth(int realPXWidth) Description copied from interface:TableColumnThe column size.NOTE: This MUST be set BEFORE adding the column to a table.
- Specified by:
setWidthin interfaceTableColumn
-
setWidthPX
public void setWidthPX(int width) - Specified by:
setWidthPXin interfaceTableColumn
-
triggerColumnSizeChange
public void triggerColumnSizeChange(int diff) - Specified by:
triggerColumnSizeChangein interfaceTableColumnCore
-
getWidth
public int getWidth()Description copied from interface:TableColumnReturns the column's size- Specified by:
getWidthin interfaceTableColumn- Returns:
- width in pixels
-
setPosition
public void setPosition(int position) Description copied from interface:TableColumnLocation to put the column. When set before being added to the UI (seeTableManager.addColumn(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:
setPositionin interfaceTableColumn- Parameters:
position- Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST
-
getPosition
public int getPosition()Description copied from interface:TableColumnReturns the position of the column- Specified by:
getPositionin interfaceTableColumn- Returns:
- Column Number (0 based), POSITION_INVISIBLE or POSITION_LAST
-
setAlignment
public void setAlignment(int alignment) Description copied from interface:TableColumnOrientation of the columns text and header.NOTE: This MUST be set BEFORE adding the column to a table.
- Specified by:
setAlignmentin interfaceTableColumn- Parameters:
alignment- ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER
-
getAlignment
public int getAlignment()Description copied from interface:TableColumnReturns the alignment of the column- Specified by:
getAlignmentin interfaceTableColumn- Returns:
- ALIGN_TRAIL, ALIGN_LEAD, or ALIGN_CENTER
-
getForegroundColor
public int[] getForegroundColor()- Specified by:
getForegroundColorin interfaceTableColumnCore
-
setForegroundColor
public void setForegroundColor(int[] rgb) - Specified by:
setForegroundColorin interfaceTableColumnCore
-
getBackgroundColor
public int[] getBackgroundColor()- Specified by:
getBackgroundColorin interfaceTableColumnCore
-
setBackgroundColor
public void setBackgroundColor(int[] rgb) - Specified by:
setBackgroundColorin interfaceTableColumnCore
-
addCellRefreshListener
Description copied from interface:TableColumnAdds a listener that triggers when a TableCell that belongs to this column needs refreshing.- Specified by:
addCellRefreshListenerin interfaceTableColumn- Parameters:
listener- Listener Object to be called when refresh is needed.
-
getCellRefreshListeners
Description copied from interface:TableColumnCoreRetrieve all the refresh listeners for the cell- Specified by:
getCellRefreshListenersin interfaceTableColumnCore- Returns:
- Cell refresh listeners
-
removeCellRefreshListener
Description copied from interface:TableColumnRemoved a previously added TableCellRefreshListener- Specified by:
removeCellRefreshListenerin interfaceTableColumn- Parameters:
listener- Previously added listener
-
hasCellRefreshListener
public boolean hasCellRefreshListener()- Specified by:
hasCellRefreshListenerin interfaceTableColumnCore- Returns:
-
setRefreshInterval
public void setRefreshInterval(int interval) Description copied from interface:TableColumnSet how often the cell receives a refresh() trigger- Specified by:
setRefreshIntervalin 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:TableColumnReturns the refresh interval of the column. The default is INTERVAL_INVALID_ONLY- Specified by:
getRefreshIntervalin interfaceTableColumn- Returns:
- INTERVAL_* constant, or a number representing the # of GUI refresh cycles between each cell refresh call.
-
addCellAddedListener
Description copied from interface:TableColumnAdds a listener that triggers when a TableCell that belongs to this column is being added.- Specified by:
addCellAddedListenerin interfaceTableColumn- Parameters:
listener- Listener Object to be called when refresh is needed.
-
addCellOtherListener
- Specified by:
addCellOtherListenerin interfaceTableColumnCore- Parameters:
listenerID-listener-
-
removeCellOtherListener
- Specified by:
removeCellOtherListenerin interfaceTableColumnCore
-
getCellOtherListeners
- Specified by:
getCellOtherListenersin interfaceTableColumnCore- Parameters:
listenerID-- Returns:
-
hasCellOtherListeners
- Specified by:
hasCellOtherListenersin interfaceTableColumnCore- Parameters:
listenerID-- Returns:
-
getCellAddedListeners
Description copied from interface:TableColumnCoreRetreive all the Cell Added listeners- Specified by:
getCellAddedListenersin interfaceTableColumnCore- Returns:
- cell added listeners for this cell
-
removeCellAddedListener
- Specified by:
removeCellAddedListenerin interfaceTableColumn
-
addCellDisposeListener
Description copied from interface:TableColumnAdds a listener that triggers when a TableCell that belongs to this column is being disposed.- Specified by:
addCellDisposeListenerin interfaceTableColumn- Parameters:
listener- Listener Object to be called when refresh is needed.
-
removeCellDisposeListener
- Specified by:
removeCellDisposeListenerin interfaceTableColumn
-
addCellToolTipListener
Description copied from interface:TableColumnAdds a listener that triggers when a TableCell that belongs to this column has a tooltip action- Specified by:
addCellToolTipListenerin interfaceTableColumn- Parameters:
listener- Listener Object to be called when refresh is needed.
-
removeCellToolTipListener
- Specified by:
removeCellToolTipListenerin interfaceTableColumn
-
addCellMouseListener
Description copied from interface:TableColumnAdds a listener that triggers when a TableCell that belongs to this column has a mouse event.- Specified by:
addCellMouseListenerin interfaceTableColumn- Parameters:
listener-
-
removeCellMouseListener
Description copied from interface:TableColumnRemove a previously added TableCellMouseListener- Specified by:
removeCellMouseListenerin interfaceTableColumn- Parameters:
listener- Previously added listener
-
addCellMenuListener
- Specified by:
addCellMenuListenerin interfaceTableColumn
-
removeCellMenuListener
- Specified by:
removeCellMenuListenerin interfaceTableColumn
-
hasCellMouseMoveListener
public boolean hasCellMouseMoveListener()- Specified by:
hasCellMouseMoveListenerin interfaceTableColumnCore- Returns:
-
addCellMouseMoveListener
-
removeCellMouseMoveListener
-
addCellClipboardListener
-
removeCellClipboardListener
-
addCellVisibilityListener
-
removeCellVisibilityListener
-
getColumnExtraInfoListeners
- Specified by:
getColumnExtraInfoListenersin interfaceTableColumnCore- Returns:
-
addColumnExtraInfoListener
- Specified by:
addColumnExtraInfoListenerin interfaceTableColumn- Parameters:
listener-
-
removeColumnExtraInfoListener
- Specified by:
removeColumnExtraInfoListenerin interfaceTableColumn- Parameters:
listener-
-
invalidateCells
public void invalidateCells()Description copied from interface:TableColumnInvalidate all cells in this column. The cells will be forced to update on the next refresh.- Specified by:
invalidateCellsin interfaceTableColumn
-
invalidateCell
Description copied from interface:TableColumnInvalidates any cells which are linked to the given data source object.- Specified by:
invalidateCellin interfaceTableColumn
-
addListeners
Description copied from interface:TableColumnA listener is added for every type of cell listener the supplied object implements- Specified by:
addListenersin interfaceTableColumn- Parameters:
listenerObject- Object implementing some cell listeneters
-
setColumnAdded
public void setColumnAdded()///////////////////////////////////////////- Specified by:
setColumnAddedin interfaceTableColumnCore
-
getColumnAdded
public boolean getColumnAdded()Description copied from interface:TableColumnCoreRetrieve whether the column has been added to the TableColumnManager- Specified by:
getColumnAddedin interfaceTableColumnCore- Returns:
- true - Column has been added
false - Column has not been added
-
setUseCoreDataSource
public void setUseCoreDataSource(boolean bCoreDataSource) Description copied from interface:TableColumnCoreChanges what} andinvalid @link
{@link TableCellCore.getDataSource()} return.invalid @link
{@link TableRowCore.getDataSource()- Specified by:
setUseCoreDataSourcein interfaceTableColumnCore- Parameters:
bCoreDataSource- true - returns a core object
false - returns a plugin object (if available)
-
getUseCoreDataSource
public boolean getUseCoreDataSource()Description copied from interface:TableColumnCoreRetrieve whether a core or plugin object is sent via getDataSource()- Specified by:
getUseCoreDataSourcein interfaceTableColumnCore- Returns:
- true - returns a core object
false - returns a plugin object (if available)
-
invokeCellRefreshListeners
Description copied from interface:TableColumnCoreSend a refresh trigger to all listeners stored in TableColumn- Specified by:
invokeCellRefreshListenersin interfaceTableColumnCore- Parameters:
cell- the cell is being refreshed- Throws:
Throwable
-
invokeCellAddedListeners
Description copied from interface:TableColumnCoreSend a cellAdded trigger to all listeners stored in TableColumn- Specified by:
invokeCellAddedListenersin interfaceTableColumnCore- Parameters:
cell- the cell is being added
-
invokeCellDisposeListeners
Description copied from interface:TableColumnCoreSend a dispose trigger to all listeners stored in TableColumn- Specified by:
invokeCellDisposeListenersin interfaceTableColumnCore- Parameters:
cell- the cell is being disposed
-
getClipboardText
- Specified by:
getClipboardTextin interfaceTableColumnCore
-
invokeCellToolTipListeners
Description copied from interface:TableColumnCoreSend a tool tip event to the tool tip listeners- Specified by:
invokeCellToolTipListenersin interfaceTableColumnCore- Parameters:
cell- Cell to get the tool tip eventtype-
-
invokeCellMouseListeners
Description copied from interface:TableColumnCoreSend a mouse event to the cell mouse listeners- Specified by:
invokeCellMouseListenersin interfaceTableColumnCore- Parameters:
event- Mouse Event to send
-
invokeCellMenuListeners
- Specified by:
invokeCellMenuListenersin interfaceTableColumnCore
-
invokeCellVisibilityListeners
Description copied from interface:TableColumnCoreSend a visibility event to the cell's visibility listeners- Specified by:
invokeCellVisibilityListenersin interfaceTableColumnCore- Parameters:
visibility- Visibility state
-
setPositionNoShift
public void setPositionNoShift(int position) Description copied from interface:TableColumnCoreSets 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:
setPositionNoShiftin interfaceTableColumnCore- Parameters:
position- new position (0 based)
-
getUserData
- Specified by:
getUserDatain interfaceTableColumn- Parameters:
key-- Returns:
- data set via setUserData()
-
getUserDataString
- Specified by:
getUserDataStringin interfaceTableColumn
-
setUserData
Description copied from interface:TableColumnAssociates custom data with the column, usually meant for column-specific settings and stores it across sessions- Specified by:
setUserDatain 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:
removeUserDatain interfaceTableColumn
-
remove
public void remove()- Specified by:
removein interfaceTableColumn
-
isRemoved
public boolean isRemoved()- Specified by:
isRemovedin interfaceTableColumnCore- Returns:
-
loadSettings
Description copied from interface:TableColumnCoreLoad width and position settings from config.- Specified by:
loadSettingsin interfaceTableColumnCore- Parameters:
mapSettings- map to place settings into
-
isFirstLoad
public boolean isFirstLoad() -
postConfigLoad
public void postConfigLoad()Description copied from interface:TableColumnimplement 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:
postConfigLoadin interfaceTableColumn
-
preAdd
public void preAdd() -
preConfigSave
public void preConfigSave()Description copied from interface:TableColumnimplement this method if you want to be notified when the column configuration is about to be serialized- Specified by:
preConfigSavein interfaceTableColumn
-
saveSettings
Description copied from interface:TableColumnCoreSave width and position settings to config.- Specified by:
saveSettingsin interfaceTableColumnCore- Parameters:
mapSettings- map to place settings into
-
getTitleLanguageKey
Description copied from interface:TableColumnCoreReturns the key in the properties bundle that has the title of the column.- Specified by:
getTitleLanguageKeyin interfaceTableColumnCore- Returns:
- Title's language key
-
getTitleLanguageKey
- Specified by:
getTitleLanguageKeyin interfaceTableColumnCore
-
getConsecutiveErrCount
public int getConsecutiveErrCount()- Specified by:
getConsecutiveErrCountin interfaceTableColumnCore- Returns:
- # of consecutive errors
-
setConsecutiveErrCount
public void setConsecutiveErrCount(int iCount) - Specified by:
setConsecutiveErrCountin interfaceTableColumnCore- Parameters:
iCount- # of consecutive errors
-
removeContextMenuItem
- Specified by:
removeContextMenuItemin interfaceTableColumnCore- Parameters:
menuItem-
-
addContextMenuItem
Description copied from interface:TableColumnAdds a Context Menu item to data section of the column- Specified by:
addContextMenuItemin 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:TableColumnAdds a Context Menu item to the column- Specified by:
addContextMenuItemin 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:
getContextMenuItemsin interfaceTableColumnCore- Returns:
-
isObfuscated
public boolean isObfuscated()Description copied from interface:TableColumnReturns whether the column's data will be obfuscated when screen capturing (for bug reports, etc).Currently not fully implemented for plugins
- Specified by:
isObfuscatedin interfaceTableColumn- Returns:
- Obfuscated value
-
setObfuscation
public void setObfuscation(boolean hideData) Description copied from interface:TableColumnSets whether the column's data will be obfuscated during a screen capture (for bug reports, etc).- Specified by:
setObfuscationin interfaceTableColumn- Parameters:
hideData- new state of obfuscation
-
getLastSortValueChange
public long getLastSortValueChange()- Specified by:
getLastSortValueChangein interfaceTableColumnCore- Returns:
-
setLastSortValueChange
public void setLastSortValueChange(long lastSortValueChange) - Specified by:
setLastSortValueChangein interfaceTableColumnCore- Parameters:
lastSortValueChange-
-
isSortValueLive
public boolean isSortValueLive()- Specified by:
isSortValueLivein interfaceTableColumnCore- Returns:
-
setSortValueLive
public void setSortValueLive(boolean live) - Specified by:
setSortValueLivein interfaceTableColumnCore- Parameters:
live-
-
addRefreshTime
public void addRefreshTime(long ms) - Specified by:
addRefreshTimein interfaceTableColumnCore- Parameters:
ms-
-
generateDiagnostics
- Specified by:
generateDiagnosticsin interfaceTableColumnCore- Parameters:
writer-
-
getListCountString
-
setTableID
- Specified by:
setTableIDin interfaceTableColumnCore- Parameters:
tableID-
-
compare
- Specified by:
comparein interfaceComparator<TableRowCore>- See Also:
-
setSortAscending
public void setSortAscending(boolean bAscending) - Specified by:
setSortAscendingin interfaceTableColumnCore- Parameters:
bAscending- The bAscending to set.
-
isSortAscending
public boolean isSortAscending()- Specified by:
isSortAscendingin interfaceTableColumnCore- Returns:
- Returns the bAscending.
-
setDefaultSortAscending
public void setDefaultSortAscending(boolean bAscending) - Specified by:
setDefaultSortAscendingin interfaceTableColumnCore- Parameters:
bAscending-
-
getMinWidth
public int getMinWidth()Description copied from interface:TableColumnGets 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:
getMinWidthin interfaceTableColumn- Returns:
- minumum width of the column
-
setMinWidth
public void setMinWidth(int minwidth) Description copied from interface:TableColumnSets 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:
setMinWidthin interfaceTableColumn- Parameters:
minwidth- new minumum width
-
getMaxWidth
public int getMaxWidth()Description copied from interface:TableColumnGets the maximum width the column can beNot all UIs may have this feature implemented.
- Specified by:
getMaxWidthin interfaceTableColumn- Returns:
- maximum width of column
-
setMaxWidth
public void setMaxWidth(int maxwidth) Description copied from interface:TableColumnSets the maximum width that the column can beNot all UIs may have this feature implemented.
- Specified by:
setMaxWidthin interfaceTableColumn- Parameters:
maxwidth- new maximum width
-
setWidthLimits
public void setWidthLimits(int min, int max) Description copied from interface:TableColumnSets the minimum and maximum widths in one callNot all UIs may have this min and max limits implemented.
- Specified by:
setWidthLimitsin interfaceTableColumn- Parameters:
min- New minimum column widthmax- New maximum column width
-
isVisible
public boolean isVisible()Description copied from interface:TableColumnGets the visibility of the columnNot all UIs may have this feature implemented.
- Specified by:
isVisiblein interfaceTableColumn- Returns:
- Column visibility
-
setVisible
public void setVisible(boolean visible) Description copied from interface:TableColumnSets the visibility of the column- Specified by:
setVisiblein interfaceTableColumn- Parameters:
visible- New visibility state
-
getPreferredWidth
public int getPreferredWidth()Description copied from interface:TableColumnGets the preferred width of the coloumn.- Specified by:
getPreferredWidthin interfaceTableColumn- Returns:
- preferred width
-
setPreferredWidthAuto
public void setPreferredWidthAuto(boolean auto) Description copied from interface:TableColumnSets 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:
setPreferredWidthAutoin interfaceTableColumn- Parameters:
auto- Preferred Width Auto State
-
isPreferredWidthAuto
public boolean isPreferredWidthAuto()Description copied from interface:TableColumnRetrieves whether the preferred width is automatically calculated.- Specified by:
isPreferredWidthAutoin 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:TableColumnSets 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:
setPreferredWidthin interfaceTableColumn- Parameters:
width- New preferred width
-
getPreferredHeaderWidth
public int getPreferredHeaderWidth()- Specified by:
getPreferredHeaderWidthin interfaceTableColumnCore
-
setPreferredHeaderWidth
public void setPreferredHeaderWidth(int width) - Specified by:
setPreferredHeaderWidthin interfaceTableColumnCore
-
setAutoTooltip
public void setAutoTooltip(boolean auto_tooltip) - Specified by:
setAutoTooltipin interfaceTableColumnCore
-
doesAutoTooltip
public boolean doesAutoTooltip()- Specified by:
doesAutoTooltipin interfaceTableColumnCore
-
setInplaceEditorListener
- Specified by:
setInplaceEditorListenerin interfaceTableColumnCore
-
hasInplaceEditorListener
public boolean hasInplaceEditorListener()- Specified by:
hasInplaceEditorListenerin interfaceTableColumnCore
-
getInplaceEditorListener
- Specified by:
getInplaceEditorListenerin interfaceTableColumnCore
-
getForDataSourceTypes
-
reset
public void reset()- Specified by:
resetin interfaceTableColumnCore
-
reset
public void reset(boolean width, boolean align, boolean fg, boolean bg) - Specified by:
resetin interfaceTableColumnCore
-
addDataSourceType
- Specified by:
addDataSourceTypein interfaceTableColumnCore- Parameters:
cla-
-
addDataSourceTypes
-
handlesDataSourceType
- Specified by:
handlesDataSourceTypein interfaceTableColumnCore
-
getForDataSourceType
- Specified by:
getForDataSourceTypein interfaceTableColumn- Returns:
-
setIconReference
- Specified by:
setIconReferencein interfaceTableColumn
-
getIconReference
- Specified by:
getIconReferencein interfaceTableColumn
-
setIconReferenceEnabled
public void setIconReferenceEnabled(boolean b) - Specified by:
setIconReferenceEnabledin interfaceTableColumn
-
getIconReferenceEnabled
public boolean getIconReferenceEnabled()- Specified by:
getIconReferenceEnabledin interfaceTableColumn
-
setMinimumRequiredUserMode
public void setMinimumRequiredUserMode(int mode) Description copied from interface:TableColumn*since 4501- Specified by:
setMinimumRequiredUserModein interfaceTableColumn- Parameters:
mode- from Parameter. constants
-
showOnlyImage
public boolean showOnlyImage()- Specified by:
showOnlyImagein interfaceTableColumnCore
-
markDirty
private void markDirty() -
isDirty
public boolean isDirty()- Specified by:
isDirtyin interfaceTableColumnCore
-