de.uni_paderborn.fujaba.preferences.gui
Class AppenderPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byde.uni_paderborn.fujaba.preferences.gui.AppenderPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class AppenderPanel
extends javax.swing.JPanel

A panel to configure a particular log4j appender

Version:
$Revision: 1.7 $
Author:
$Author: schneider $
See Also:
Serialized Form

Nested Class Summary
private  class AppenderPanel.FileSelector
          A text field to show the selected file and a button to bring the file selector up
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  java.util.Hashtable componentMap
          Components in panel which are additional to the default mapped to corresponding parameter names
private  java.lang.String configName
          Name used to refer to appender in log4j config file
private  java.awt.GridBagConstraints constraints
          Layout constraints for panel
private static java.lang.String CONVERSION_PATTERN
          Constant to show that text field contains info on a pattern
private  java.lang.String displayName
          Name used to refer to appender in GUI
(package private)  javax.swing.JCheckBox enabledBox
          Determines whether appender is enabled or not
private  java.awt.GridBagLayout gridBag
          Layout of panel
private static java.lang.String JLABEL
          Constant for JLabels to map to
private  javax.swing.JComboBox thresholdCombo
          Threshold of appender
private  javax.swing.JLabel thresholdLabel
          Label for threshold combo box
private  java.lang.String[] THRESHOLDS
          Selectable thresholds
 
Fields inherited from class javax.swing.JPanel
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AppenderPanel(java.lang.String theDisplayName, java.lang.String theConfigName)
          Creates a new appender panel
 
Method Summary
 void addCheckBox(java.lang.String name, java.lang.String param)
          Add a labelled check box
private  void addComponent(javax.swing.JLabel label, javax.swing.JComponent component)
          Add a component to panel with a label.
 void addFileSelector(java.lang.String name, java.lang.String param)
          Add a labelled file selector
 void addPatternField()
          Add a text field to configure the conversion pattern used
 void addTextField(java.lang.String name, java.lang.String param)
          Add a labelled text field
 java.lang.String getConfigName()
          getter for field configName
private  void getThreshold()
          Determine whether an appender is on from the node which defines it.
 void setContentsEnabled(boolean enabled)
          Enables or disables the panel contents.
(package private)  void setFieldsEnabled(boolean enabled)
          Enables or disables the contents of the panel, except for the checkbox.
 void setOptions()
          Set the options in the panel according to information in log4j config file
private  void setThreshold()
          Set the threshold for an appender according to current options selected in the GUI
 void updateOptions()
          Update the log4j config file according to the selections in the panel
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

displayName

private java.lang.String displayName
Name used to refer to appender in GUI


configName

private java.lang.String configName
Name used to refer to appender in log4j config file


enabledBox

javax.swing.JCheckBox enabledBox
Determines whether appender is enabled or not


THRESHOLDS

private final java.lang.String[] THRESHOLDS
Selectable thresholds


thresholdLabel

private javax.swing.JLabel thresholdLabel
Label for threshold combo box


thresholdCombo

private javax.swing.JComboBox thresholdCombo
Threshold of appender


gridBag

private java.awt.GridBagLayout gridBag
Layout of panel


constraints

private java.awt.GridBagConstraints constraints
Layout constraints for panel


componentMap

private java.util.Hashtable componentMap
Components in panel which are additional to the default mapped to corresponding parameter names


CONVERSION_PATTERN

private static final java.lang.String CONVERSION_PATTERN
Constant to show that text field contains info on a pattern

See Also:
Constant Field Values

JLABEL

private static final java.lang.String JLABEL
Constant for JLabels to map to

See Also:
Constant Field Values
Constructor Detail

AppenderPanel

public AppenderPanel(java.lang.String theDisplayName,
                     java.lang.String theConfigName)
Creates a new appender panel

Parameters:
theDisplayName - name used to refer to appender in GUI
theConfigName - name used to refer to appender in log4j config file
Method Detail

getConfigName

public java.lang.String getConfigName()
getter for field configName

Returns:
current value of field configName

addCheckBox

public void addCheckBox(java.lang.String name,
                        java.lang.String param)
Add a labelled check box

Parameters:
name - the label for the check box in the GUI
param - the parameter which the check box corresponds to

addTextField

public void addTextField(java.lang.String name,
                         java.lang.String param)
Add a labelled text field

Parameters:
name - the label for the field in the GUI
param - the parameter which the field corresponds to

addFileSelector

public void addFileSelector(java.lang.String name,
                            java.lang.String param)
Add a labelled file selector

Parameters:
name - the label for the file selector in the GUI
param - the parameter which the file selector corresponds to

addPatternField

public void addPatternField()
Add a text field to configure the conversion pattern used


addComponent

private void addComponent(javax.swing.JLabel label,
                          javax.swing.JComponent component)
Add a component to panel with a label.

Parameters:
label - the label for the component
component - the component

setOptions

public void setOptions()
Set the options in the panel according to information in log4j config file


updateOptions

public void updateOptions()
Update the log4j config file according to the selections in the panel


setContentsEnabled

public void setContentsEnabled(boolean enabled)
Enables or disables the panel contents. Different to setEnabled as it affects all the components in the panel, rather than the panel itself.

Parameters:
enabled - true to enable, false to disable

setFieldsEnabled

void setFieldsEnabled(boolean enabled)
Enables or disables the contents of the panel, except for the checkbox.

Parameters:
enabled - true to enable, false to disable

getThreshold

private void getThreshold()
Determine whether an appender is on from the node which defines it. If it's on, determine which threshold it is running at.


setThreshold

private void setThreshold()
Set the threshold for an appender according to current options selected in the GUI