Field Detail

• clientListModel_

  private final javax.swing.ListModel clientListModel_

• connectionListenerList_

  private final java.util.List connectionListenerList_

• updateMap_

  private final java.util.Map updateMap_

• wasConnected_

  private boolean wasConnected_

• ENABLE_ACTION

  static GuiHubConnector.ConnectionUpdate ENABLE_ACTION

• DISABLE_ACTION

  static GuiHubConnector.ConnectionUpdate DISABLE_ACTION

• REPAINT_COMPONENT

  static GuiHubConnector.ConnectionUpdate REPAINT_COMPONENT

• ENABLE_COMPONENT

  static GuiHubConnector.ConnectionUpdate ENABLE_COMPONENT

Constructor Detail

• GuiHubConnector

  public GuiHubConnector​(ClientProfile profile)

  Constructs a hub connector based on a given profile instance.

  Parameters:

  profile - profile implementation

Method Detail

• connectionChanged

  protected void connectionChanged​(boolean isConnected)

  Description copied from class: HubConnector
  Method which is called every time this connector changes its connection status (from disconnected to connected, or vice versa). The default implementation does nothing, but it may be overridden by subclasses wishing to be informed of these events.

  Overrides:

  connectionChanged in class HubConnector

  Parameters:

  isConnected - true if we've just registered; false if we've just unregistered

• addConnectionListener

  public void addConnectionListener​(javax.swing.event.ChangeListener listener)

  Adds a listener which will be notified when this connector registers or unregisters with a hub.

  Parameters:

  listener - listener to add

• removeConnectionListener

  public void removeConnectionListener​(javax.swing.event.ChangeListener listener)

  Removes a listener previously added by addConnectionListener.

  Parameters:

  listener - listener to remove

• getClientListModel

  public javax.swing.ListModel getClientListModel()

  Returns a ListModel containing the registered clients. Listeners to this model are correctly notified whenever any change in its contents takes place.

  Returns:

  list model containing Client objects

• createClientListCellRenderer

  public javax.swing.ListCellRenderer createClientListCellRenderer()

  Returns a list cell renderer suitable for use with the client list model returned by getClientListModel().

  Returns:

  list cell renderer for Client objects

• createRegisterAction

  public javax.swing.Action createRegisterAction()

  Returns an action which attempts to register with the hub. Disabled when already registered.

  Returns:

  registration action

• createUnregisterAction

  public javax.swing.Action createUnregisterAction()

  Returns an action which attempts to unregister from the hub. Disabled when already unregistered.

  Returns:

  unregistration action

• createToggleRegisterAction

  public javax.swing.Action createToggleRegisterAction()

  Returns an action which toggles hub registration.

  Returns:

  registration toggler action

• createRegisterOrHubAction

  public javax.swing.Action createRegisterOrHubAction​(java.awt.Component parent,
                                                      javax.swing.Action[] hubStartActions)

  Returns a new action which will register with a hub if one is running, and if not, will offer to start a hub. The exact options for starting a hub are given by the hubStartActions parameter - the elements of this array will normally be generated by calling the createHubAction method.

  Parameters:

  parent - parent component, used for placing dialogue

  hubStartActions - actions which start a hub, or null for a default list

• createShowMonitorAction

  public javax.swing.Action createShowMonitorAction()

  Returns an action which will display a SAMP hub monitor window.

  Returns:

  monitor window action

• createHubAction

  public javax.swing.Action createHubAction​(boolean external,
                                            HubServiceMode hubMode)

  Returns an action which will start up a SAMP hub. You can specify whether it runs in the current JVM or a newly created one; in the former case, it will shut down when the current application does.

  Parameters:

  external - false to run in the current JVM, true to run in a new one

  hubMode - hub mode

• createConnectionIndicator

  public javax.swing.JComponent createConnectionIndicator​(javax.swing.Icon onIcon,
                                                          javax.swing.Icon offIcon)

  Creates a component which indicates whether this connector is currently connected or not, using supplied icons.

  Parameters:

  onIcon - icon indicating connection

  offIcon - icon indicating no connection

  Returns:

  connection indicator

• createConnectionIndicator

  public javax.swing.JComponent createConnectionIndicator()

  Creates a component which indicates whether this connector is currently connected or not, using default icons.

  Returns:

  connection indicator

• createClientBox

  public javax.swing.JComponent createClientBox​(boolean vertical,
                                                int iconSize)

  Creates a component which shows an icon for each registered client.

  Parameters:

  vertical - true for vertical box, false for horizontal

  iconSize - dimension in pixel of each icon (square)

• createMonitorPanel

  public javax.swing.JComponent createMonitorPanel()

  Returns a new component which displays status for this connector.

  Returns:

  new hub connection monitor component

• scheduleConnectionChange

  private void scheduleConnectionChange()

  Called when the connection status (registered/unregistered) may have changed. May be called from any thread.

• updateConnectionState

  private void updateConnectionState()

  Called when the connection status has changed, or may have changed.

• createBoxBorder

  static javax.swing.border.Border createBoxBorder()

  Returns a border suitable for icon boxes.

  Returns:

  border

• registerUpdater

  void registerUpdater​(java.lang.Object item,
                       GuiHubConnector.ConnectionUpdate updater)

  Adds a given item to the list of objects which will be notified when the hub is connected/disconnected. By doing it like this rather than with the usual listener mechanism the problem of retaining references to otherwise unused listeners is circumvented.

  Parameters:

  item - object to be notified

  updater - object which performs the notification on hub connect/disconnect