Package com.biglybt.pif.ui.tables
Interface TableColumn
- All Known Subinterfaces:
TableColumnCore
- All Known Implementing Classes:
AlertsItem
,AnnounceCountItem
,ASItem
,AvailabilityItem
,AvailabilityItem
,AverageBytesInItem
,AverageBytesOutItem
,AvgAvailItem
,BadAvailTimeItem
,BadNATCountItem
,BlockCountItem
,BlocksItem
,BytesQueuedForUpload
,CategoryIconsItem
,CategoryItem
,CategoryItem
,CategoryItem
,ChokedItem
,ChokingItem
,ClientIdentificationItem
,ClientItem
,ColumnActivityActions
,ColumnActivityDate
,ColumnActivityNew
,ColumnActivityText
,ColumnActivityType
,ColumnCheckBox2
,ColumnControls
,ColumnDateSizer
,ColumnDoneWithDND
,ColumnFileCount
,ColumnPeerNetwork
,ColumnProgressETA
,ColumnSearchSubResultTags
,ColumnSizeWithDND
,ColumnStream
,ColumnSubscriptionActions
,ColumnSubscriptionAutoDownload
,ColumnSubscriptionCategory
,ColumnSubscriptionDependsOn
,ColumnSubscriptionEnabled
,ColumnSubscriptionError
,ColumnSubscriptionLastChecked
,ColumnSubscriptionMaxResults
,ColumnSubscriptionName
,ColumnSubscriptionNbNewResults
,ColumnSubscriptionNbResults
,ColumnSubscriptionNew
,ColumnSubscriptionNewestDate
,ColumnSubscriptionNextUpdate
,ColumnSubscriptionParent
,ColumnSubscriptionProtocol
,ColumnSubscriptionPublic
,ColumnSubscriptionSubscribers
,ColumnSubscriptionTag
,ColumnSubscriptionUpdatePeriod
,ColumnSubscriptionURL
,ColumnTC_ChosenColumn
,ColumnTC_Info
,ColumnTC_NameInfo
,ColumnTC_Sample
,ColumnThumbAndName
,ColumnThumbnail
,ColumnTorrentSpeed
,ColumnUnopened
,CommentIconItem
,CommentItem
,CompletedCountItem
,CompletedItem
,CompletedItem
,CompletedItem
,CompletionItem
,ConnectedTimeItem
,ConnectHealthItem
,CoreTableColumn
,CoreTableColumnSWT
,DateAddedItem
,DateAddedItem
,DateCompletedItem
,DateFileCompletedItem
,DateItem
,DateLastActiveItem
,DateLastQueuedItem
,DateLastXferItem
,DescriptionItem
,DiscardedItem
,DiskLatencyItem
,DLedFromOthersItem
,DoneBytesItem
,DoneItem
,DoneItem
,DownItem
,DownItem
,DownloadedItem
,DownloadHealthItem
,DownloadNameItem
,DownloadNameItem
,DownloadNameItem
,DownSpeedItem
,DownSpeedItem
,DownSpeedLimitItem
,DownSpeedLimitItem
,EncryptionItem
,ETAItem
,ExternalItem
,FileAvailabilityItem
,FileCRC32Item
,FileCreationItem
,FileETAItem
,FileExtensionItem
,FileExtensionItem
,FileHashItemBase
,FileIndexItem
,FileIndexPlus1Item
,FileMD5Item
,FileModifiedItem
,FilePrioritiesItem
,FileReadSpeedItem
,FilesDoneItem
,FileSHA1Item
,FilesItem
,FilesLinkedItem
,FileWriteSpeedItem
,FirstPieceItem
,GainItem
,HandshakeReservedBytesItem
,HealthItem
,HostNameItem
,IncomingRequestCountItem
,IndexItem
,InterestedItem
,InterestingItem
,IntervalItem
,IPFilterItem
,IpItem
,LANItem
,LastPieceItem
,LastScrapeTimeItem
,LastUpdateItem
,LatencyItem
,LeecherMaxCompletion
,LeechersItem
,LeftItem
,LocalInterfaceItem
,MaskedItem
,MaxSRItem
,MaxUploadsItem
,MergedDataItem
,MessagingItem
,MinSRItem
,ModeItem
,MoveOnCompleteItem
,NameItem
,NameItem
,NameItem
,NameItem
,NameItem
,NameItem
,NetworksIconsItem
,NetworksItem
,OnlyCDing4Item
,OptimisticUnchokeItem
,OutgoingRequestCountItem
,PassiveItem
,PathItem
,PathNameItem
,PeakDownItem
,PeakUpItem
,PeerByteIDItem
,PeerCountItem
,PeerFilesView.NameItem
,PeerFilesView.PercentItem
,PeerFilesView.PiecesItem
,PeerIDItem
,PeersItem
,PeersItem
,PeerSourceItem
,PeerSourcesItem
,PercentHaveTheyNeedItem
,PercentHaveWeNeedItem
,PercentItem
,PercentItem
,PersistentItem
,PersistentItem
,PieceCountItem
,PieceItem
,PieceNumberItem
,PiecesDoneAndCountItem
,PiecesItem
,PiecesItem
,PortItem
,PriorityItem
,PriorityItem
,ProgressGraphItem
,ProtocolItem
,RankItem
,RelocatedItem
,RemainingItem
,RemainingPiecesItem
,ReportedDownItem
,ReportedUpItem
,RequestedItem
,ReservedByItem
,SavePathItem
,ScrapeCountItem
,SecondsDownloadingItem
,SecondsSeedingItem
,SeedCountItem
,SeedsItem
,SeedsItem
,SeedToPeerRatioItem
,SessionDownItem
,SessionUpItem
,ShareRatioItem
,ShareRatioProgressItem
,SizeBytesItem
,SizeItem
,SizeItem
,SizeItem
,SizeItem
,SmoothedDownItem
,SmoothedETAItem
,SmoothedUpItem
,SnubbedItem
,SpeedItem
,StateItem
,StatUpItem
,StatusItem
,StatusItem
,StatusItem
,StorageTypeItem
,SuperSeedingItem
,SwarmAverageCompletion
,SwarmAverageSpeed
,SwarmMaxCompletion
,SwarmTagsItem
,TableColumnImpl
,TagAddedToDateItem
,TagColorsItem
,TagIconsItem
,TagsColumn
,TagsItem
,TagsItem
,TagSortItem
,TimeSinceDownloadItem
,TimeSinceUploadItem
,TimeToSendPieceItem
,TimeUntilCompleteItem
,TorrentCreateDateItem
,TorrentPathItem
,TorrentRelativePathItem
,TorrentV2RootHashItem
,TotalBytesInItem
,TotalBytesOutItem
,TotalDownSpeedItem
,TotalSpeedItem
,TrackerItem
,TrackerNameItem
,TrackerNextAccessItem
,TrackerStatusItem
,TypeItem
,TypeItem
,TypeItem
,TypeItem
,UniquePieceItem
,UpdateInItem
,UpDownRatioItem
,UpItem
,UpItem
,UploadedItem
,UploadHealthItem
,UploadPriorityItem
,UpRatioItem
,UpSpeedItem
,UpSpeedItem
,UpSpeedLimitItem
,UpSpeedLimitItem
,WritersItem
public interface TableColumn
This interface provides access to an Azureus table column.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
bottom alignstatic final int
center alignmentstatic final int
leading alignmentstatic final int
top alignstatic final int
trailing alignmentstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final int
Trigger refresh listeners every time a graphic cycle occurs (set by user)static final int
Trigger refresh only when the cell/row becomes invalidstatic final int
Trigger refresh listeners every time a GUI update cycle occurs (set by user)static final int
static final int
static final int
ForsetPosition(int)
.static final int
ForsetPosition(int)
.static final int
The graphic type, providing access to graphic specific functions inTableCell
.static final int
The cells in this column display textual information.static final int
The cells in this column display only textual information, and does not set any other visible properties of cell (background, foreground, icon, etc).static final String
-
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
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
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
addContextMenuItem
(String resourceKey) Adds a Context Menu item to data section of the columnaddContextMenuItem
(String resourceKey, int menuStyle) Adds a Context Menu item to the columnvoid
addListeners
(Object listenerObject) A listener is added for every type of cell listener the supplied object implementsint
Returns the alignment of the columnboolean
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
Gets the preferred width of the coloumn.int
Returns the refresh interval of the column.Which table the column will be visible in.int
getType()
Returns the type of the contained data.getUserData
(String key) getUserDataString
(String key) int
getWidth()
Returns the column's sizevoid
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.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
Gets the visibility of the columnvoid
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
implement this method if you want to be notified when the column configuration is about to be serializedvoid
remove()
void
void
void
removeCellMenuListener
(TableCellMenuListener listener) void
Remove a previously added TableCellMouseListenervoid
Removed a previously added TableCellRefreshListenervoid
void
void
removeUserData
(String key) void
setAlignment
(int alignment) Orientation of the columns text and header.void
setIconReference
(String iconID, boolean showOnlyIcon) void
setIconReferenceEnabled
(boolean b) 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
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() triggervoid
setType
(int type) The type of the contained data.
Current supported types are long, string, and graphic.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 unadjustedWidth) The column size.void
setWidthLimits
(int min, int max) Sets the minimum and maximum widths in one callvoid
setWidthPX
(int realPixelWidth)
-
Field Details
-
MENU_STYLE_HEADER
static final int MENU_STYLE_HEADER- See Also:
-
MENU_STYLE_COLUMN_DATA
static final int MENU_STYLE_COLUMN_DATA- See Also:
-
TYPE_TEXT
static final int TYPE_TEXTThe cells in this column display textual information.- See Also:
-
TYPE_GRAPHIC
static final int TYPE_GRAPHICThe graphic type, providing access to graphic specific functions inTableCell
.- See Also:
-
TYPE_TEXT_ONLY
static final int TYPE_TEXT_ONLYThe 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 us to call refresh less, and saves on CPU.- See Also:
-
ALIGN_LEAD
static final int ALIGN_LEADleading alignment- See Also:
-
ALIGN_TRAIL
static final int ALIGN_TRAILtrailing alignment- See Also:
-
ALIGN_CENTER
static final int ALIGN_CENTERcenter alignment- See Also:
-
ALIGN_TOP
static final int ALIGN_TOPtop align- See Also:
-
ALIGN_BOTTOM
static final int ALIGN_BOTTOMbottom align- See Also:
-
POSITION_INVISIBLE
static final int POSITION_INVISIBLEForsetPosition(int)
. Make column invisible initially.- See Also:
-
POSITION_LAST
static final int POSITION_LASTForsetPosition(int)
. Make column the last column initially.- See Also:
-
INTERVAL_GRAPHIC
static final int INTERVAL_GRAPHICTrigger refresh listeners every time a graphic cycle occurs (set by user)- See Also:
-
INTERVAL_LIVE
static final int INTERVAL_LIVETrigger refresh listeners every time a GUI update cycle occurs (set by user)- See Also:
-
INTERVAL_INVALID_ONLY
static final int INTERVAL_INVALID_ONLYTrigger refresh only when the cell/row becomes invalid- See Also:
-
CAT_ESSENTIAL
- See Also:
-
CAT_SHARING
- See Also:
-
CAT_TRACKER
- See Also:
-
CAT_TIME
- See Also:
-
CAT_SWARM
- See Also:
-
CAT_CONTENT
- See Also:
-
CAT_PEER_IDENTIFICATION
- See Also:
-
CAT_PROTOCOL
- See Also:
-
CAT_BYTES
- See Also:
-
CAT_SETTINGS
- See Also:
-
CAT_CONNECTION
- See Also:
-
CAT_PROGRESS
- See Also:
-
UD_FORCE_VISIBLE
- See Also:
-
-
Method Details
-
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
- SeesetAlignment(int)
iPosition
- SeesetPosition(int)
iWidth
- SeesetWidth(int)
iInterval
- SeesetRefreshInterval(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
- SeesetAlignment(int)
iPosition
- SeesetPosition(int)
iWidth
- SeesetWidth(int)
- Since:
- 2.1.0.0
-
getName
String getName()The logical name of the column. This was set viaTableManager.createColumn(java.lang.String, java.lang.String)
and can not be changed.- Returns:
- the column name (identification)
- Since:
- 2.1.0.0
-
getNameOverride
String getNameOverride()Returns the user's column name override if it exists- Returns:
- Since:
- 5.0.0.1
-
setNameOverride
-
getTableID
String getTableID()Which table the column will be visible in. This was set viaTableManager.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 isTYPE_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 unadjustedWidth) The column size.NOTE: This MUST be set BEFORE adding the column to a table.
- Parameters:
width
- the size in pixels, adjusting for DPI- Since:
- 2.1.0.0
-
setWidthPX
void setWidthPX(int realPixelWidth) -
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 (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.- 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 beNot 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 beNot 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 callNot all UIs may have this min and max limits implemented.
- Parameters:
min
- New minimum column widthmax
- New maximum column width- 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 columnNot all UIs may have this feature implemented.
- Returns:
- Column visibility
- Since:
- 3.0.0.7
-
setUserData
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 serializedvalue
- should be BEncodable, otherwise it won't be serialized
-
removeUserData
-
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
- Parameters:
key
-- Returns:
- data set via setUserData()
-
getUserDataString
-
setVisible
void setVisible(boolean visible) Sets the visibility of the column- Parameters:
visible
- New visibility state- Since:
- 3.0.0.7
-
addCellRefreshListener
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
Removed a previously added TableCellRefreshListener- Parameters:
listener
- Previously added listener- Since:
- 2.1.0.0
-
addCellAddedListener
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
-
addCellDisposeListener
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
-
addCellToolTipListener
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
-
addCellMouseListener
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
Remove a previously added TableCellMouseListener- Parameters:
listener
- Previously added listener- Since:
- 2.3.0.7
-
addCellMenuListener
-
removeCellMenuListener
-
addListeners
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
Invalidates any cells which are linked to the given data source object.- Since:
- 3.0.1.5
-
addContextMenuItem
Adds a Context Menu item to the column- Parameters:
resourceKey
- 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
- Since:
- 4.2.0.5
-
addContextMenuItem
Adds a Context Menu item to data section of the column- 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
-
isObfuscated
boolean isObfuscated()Returns whether the column's data will be obfuscated when screen capturing (for bug reports, etc).Currently not fully implemented for plugins
- Returns:
- Obfuscated value
- Since:
- 2.4.0.3
-
setObfuscation
void setObfuscation(boolean hideData) Sets whether the column's data will be obfuscated during a screen capture (for bug reports, etc).- Parameters:
hideData
- new state of obfuscation- Since:
- 2.4.0.3
-
remove
void remove()- Since:
- 4005
-
addColumnExtraInfoListener
- Parameters:
listener
-- Since:
- 4.0.0.5
-
removeColumnExtraInfoListener
- Parameters:
listener
-- Since:
- 4.0.0.5
-
getForDataSourceType
Class getForDataSourceType()- Returns:
- Since:
- 4.0.0.5
-
setIconReference
- Since:
- 4.4.0.7
-
getIconReference
String getIconReference()- Since:
- 4.4.0.7
-
getIconReferenceEnabled
boolean getIconReferenceEnabled()- Since:
- 3.6.0.1
-
setIconReferenceEnabled
void setIconReferenceEnabled(boolean b) - Since:
- 3.6.0.1
-
setMinimumRequiredUserMode
void setMinimumRequiredUserMode(int mode) *since 4501- Parameters:
mode
- from Parameter. constants
-