Class ReceiversPanel

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, SettingsListener

public class ReceiversPanel extends JPanel implements SettingsListener
This panel is used to manage all the Receivers configured within Log4j
See Also:
  • Field Details

    • newReceiverButtonAction

      final Action newReceiverButtonAction
    • pauseReceiverButtonAction

      final Action pauseReceiverButtonAction
    • playReceiverButtonAction

      final Action playReceiverButtonAction
    • shutdownReceiverButtonAction

      final Action shutdownReceiverButtonAction
    • saveReceiversButtonAction

      final Action saveReceiversButtonAction
    • restartReceiverButtonAction

      final Action restartReceiverButtonAction
    • showReceiverHelpAction

      private final Action showReceiverHelpAction
    • startAllAction

      private final Action startAllAction
    • popupMenu

      private final JPopupMenu popupMenu
    • receiversTree

      private final JTree receiversTree
    • newReceiverPopup

      private final ReceiversPanel.NewReceiverPopupMenu newReceiverPopup
    • buttonPanel

      private final ReceiversPanel.ReceiverToolbar buttonPanel
    • splitter

      private final JSplitPane splitter
    • pluginEditorPanel

      private final PluginPropertyEditorPanel pluginEditorPanel
    • logger

      private final org.apache.log4j.Logger logger
    • pluginRegistry

      private final PluginRegistry pluginRegistry
  • Constructor Details

    • ReceiversPanel

      public ReceiversPanel()
  • Method Details

    • saveReceivers

      private void saveReceivers()
    • getReceiverTreeModel

      protected ReceiversTreeModel getReceiverTreeModel()
    • updateCurrentlySelectedNodeInDispatchThread

      protected void updateCurrentlySelectedNodeInDispatchThread()
    • getCurrentlySelectedReceiver

      private Receiver getCurrentlySelectedReceiver()
      Returns the currently selected Receiver, or null if there is no selected Receiver (this could be because a) nothing at all is selected or b) a non Receiver type node is selected
      Returns:
      Receiver or null
    • getSelectedReceivers

      private Receiver[] getSelectedReceivers()
    • getCurrentlySelectedUserObject

      private Object getCurrentlySelectedUserObject()
      Returns the currently seleted node's User Object, or null if there is no selected node, or if the currently selected node has not user Object
      Returns:
      Object representing currently seleted Node's User Object
    • pauseCurrentlySelectedReceiver

      private void pauseCurrentlySelectedReceiver()
      Takes the currently selected Receiver and pauess it, effectively discarding any received event BEFORE it is even posted to the logger repository.

      The user is NOT asked to confirm this operation

    • playCurrentlySelectedReceiver

      private void playCurrentlySelectedReceiver()
      Ensures that the currently selected receiver active property is set to true
    • shutdownCurrentlySelectedReceiver

      private void shutdownCurrentlySelectedReceiver()
      Takes the currently selected Receiver and stops it, which effectively removes it from the PluginRegistry.

      The user is asked to confirm this operation

    • updateActions

      private void updateActions()
      Sets the state of actions depending on certain conditions (i.e what is currently selected etc.)
    • updateReceiverTreeInDispatchThread

      public void updateReceiverTreeInDispatchThread()
      Ensures that the Receiver tree is updated with the latest information and that this operation occurs in the Swing Event Dispatch thread.
    • setVisible

      public void setVisible(boolean aFlag)
      Overrides:
      setVisible in class JComponent
    • loadSettings

      public void loadSettings(LoadSettingsEvent event)
      Description copied from interface: SettingsListener
      When a request to load Settings has been requested, this method will be invoked by the SettingsManager. The implementing component can query the event for settings, and modify it's internal state based on these settings.
      Specified by:
      loadSettings in interface SettingsListener
    • saveSettings

      public void saveSettings(SaveSettingsEvent event)
      Saves all the receivers which are active at shut down as a configuration file which can be loaded when Chainsaw will be restarted.
      Specified by:
      saveSettings in interface SettingsListener