Package org.astrogrid.samp.gui
Class MessageTrackerHubConnector
- java.lang.Object
-
- org.astrogrid.samp.client.HubConnector
-
- org.astrogrid.samp.gui.GuiHubConnector
-
- org.astrogrid.samp.gui.MessageTrackerHubConnector
-
public class MessageTrackerHubConnector extends GuiHubConnector
HubConnector implementation which provides facilities for keeping track of incoming and outgoing messages as well as the other GUI features.- Since:
- 26 Nov 2008
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description MessageTrackerHubConnector(ClientProfile profile)
Constructs a hub connector with default message tracker GUI expiry times.MessageTrackerHubConnector(ClientProfile profile, int listRemoveDelay, int tableRemoveDelay, int tableMaxRows)
Constructs a hub connector with specified message tracker GUI expiry times.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.swing.ListCellRenderer
createClientListCellRenderer()
Returns a list cell renderer suitable for use with the client list model returned byGuiHubConnector.getClientListModel()
.protected HubConnection
createConnection()
Invoked by this class to create a hub connection.javax.swing.JComponent
createMessageBox(int iconSize)
Returns a component which displays messages currently being sent/received by this connector.static javax.swing.JComponent
createMessageBox(int iconSize, javax.swing.ListModel rxListModel, javax.swing.ListModel txListModel)
Returns a component which displays messages in receiver and/or sender list models.javax.swing.JComponent
createMonitorPanel()
Returns a new component which displays status for this connector.javax.swing.ListModel
getRxListModel()
Returns a ListModel representing the pending messages received using this connector.javax.swing.ListModel
getRxListModel(Client client)
javax.swing.ListModel
getTxListModel()
Returns a ListModel representing the pending messages sent using this connector.javax.swing.ListModel
getTxListModel(Client client)
-
Methods inherited from class org.astrogrid.samp.gui.GuiHubConnector
addConnectionListener, connectionChanged, createClientBox, createConnectionIndicator, createConnectionIndicator, createHubAction, createRegisterAction, createRegisterOrHubAction, createShowMonitorAction, createToggleRegisterAction, createUnregisterAction, getClientListModel, removeConnectionListener
-
Methods inherited from class org.astrogrid.samp.client.HubConnector
addMessageHandler, addResponseHandler, call, callAll, callAndWait, computeSubscriptions, configureConnection, createTag, declareMetadata, declareSubscriptions, disconnect, getClientMap, getClientSet, getConnection, getMetadata, getSubscriptions, isActive, isConnected, removeMessageHandler, removeResponseHandler, setActive, setAutoconnect
-
-
-
-
Constructor Detail
-
MessageTrackerHubConnector
public MessageTrackerHubConnector(ClientProfile profile)
Constructs a hub connector with default message tracker GUI expiry times.- Parameters:
profile
- profile implementation
-
MessageTrackerHubConnector
public MessageTrackerHubConnector(ClientProfile profile, int listRemoveDelay, int tableRemoveDelay, int tableMaxRows)
Constructs a hub connector with specified message tracker GUI expiry times. The delay times are times in milliseconds after message resolution before message representations expire and hence remove themselves from gui components.- Parameters:
profile
- profile implementationlistRemoveDelay
- expiry delay for summary icons in client list displaytableRemoveDelay
- expiry delay for rows in message table displaytableMaxRows
- maximum number of rows in message table (beyond this limit resolved messages may be removed early)
-
-
Method Detail
-
getTxListModel
public javax.swing.ListModel getTxListModel()
Returns a ListModel representing the pending messages sent using this connector. Elements of the model areTransmission
objects.- Returns:
- transmission list model
-
getRxListModel
public javax.swing.ListModel getRxListModel()
Returns a ListModel representing the pending messages received using this connector. Elements of the model areTransmission
objects.- Returns:
- transmission list model
-
getTxListModel
public javax.swing.ListModel getTxListModel(Client client)
-
getRxListModel
public javax.swing.ListModel getRxListModel(Client client)
-
createMessageBox
public javax.swing.JComponent createMessageBox(int iconSize)
Returns a component which displays messages currently being sent/received by this connector.- Returns:
- iconSize height of icons in box
-
createMessageBox
public static javax.swing.JComponent createMessageBox(int iconSize, javax.swing.ListModel rxListModel, javax.swing.ListModel txListModel)
Returns a component which displays messages in receiver and/or sender list models.- Parameters:
iconSize
- height of iconsrxListModel
- list model containing receivedTransmission
objectstxListModel
- list model containing sentTransmission
objects
-
createClientListCellRenderer
public javax.swing.ListCellRenderer createClientListCellRenderer()
Description copied from class:GuiHubConnector
Returns a list cell renderer suitable for use with the client list model returned byGuiHubConnector.getClientListModel()
.- Overrides:
createClientListCellRenderer
in classGuiHubConnector
- Returns:
- list cell renderer for Client objects
-
createMonitorPanel
public javax.swing.JComponent createMonitorPanel()
Description copied from class:GuiHubConnector
Returns a new component which displays status for this connector.- Overrides:
createMonitorPanel
in classGuiHubConnector
- Returns:
- new hub connection monitor component
-
createConnection
protected HubConnection createConnection() throws SampException
Description copied from class:HubConnector
Invoked by this class to create a hub connection. The default implementation just callsprofile.register()
.- Overrides:
createConnection
in classHubConnector
- Returns:
- new hub connection
- Throws:
SampException
-
-