org.opends.guitools.controlpanel.ui

Class MonitoringAttributesViewPanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.opends.guitools.controlpanel.ui.StatusGenericPanel

org.opends.guitools.controlpanel.ui.MonitoringAttributesViewPanel<T>

Type Parameters:

T - the type of the objects that this panel manages. For now it only manages String and MonitoringAttribute objects.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ConfigChangeListener

public class MonitoringAttributesViewPanel<T>
extends StatusGenericPanel

The panel that allows the user to select which attributes must be displayed in the traffic monitoring tables.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.guitools.controlpanel.ui.StatusGenericPanel

StatusGenericPanel.IgnoreItemListener

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class org.opends.guitools.controlpanel.ui.StatusGenericPanel

COMBO_SEPARATOR, errorPane, NOT_APPLICABLE

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.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

Constructors

Modifier	Constructor and Description
protected	MonitoringAttributesViewPanel(LinkedHashSet<T> attributes) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	configurationChanged(ConfigurationChangeEvent ev) Method that is called when a change in the configuration occurred.
static MonitoringAttributesViewPanel<LocalizableMessage>	createMessageInstance(LinkedHashSet<LocalizableMessage> attributes) Creates an instance of this panel that uses LocalizableMessage as attributes.
static MonitoringAttributesViewPanel<MonitoringAttributes>	createMonitoringAttributesInstance(LinkedHashSet<MonitoringAttributes> attributes) Creates an instance of this panel that uses MonitoringAttributes as attributes.
static MonitoringAttributesViewPanel<String>	createStringInstance(LinkedHashSet<String> attributes) Creates an instance of this panel that uses String as attributes.
LinkedHashSet<T>	getAttributes() Returns the list of attributes that the user selected.
GenericDialog.ButtonType	getButtonType() Returns the buttons that the dialog where this panel is contained should display.
protected LocalizableMessage	getMessage(T attribute) Returns the message for the provided attribute.
Component	getPreferredFocusComponent() Returns the component that should get the focus when the dialog that contains this panel is displayed.
LocalizableMessage	getTitle() Returns the title that will be used as title of the dialog.
boolean	isCanceled() Returns true if the user closed the dialog by cancelling it and false otherwise.
void	okClicked() Notification that the ok button has been clicked, the panel is in charge of doing whatever is required (close the dialog, launch a task, etc.).
boolean	requiresScroll() Tells whether this panel should be contained in a scroll pane or not.
void	setSelectedAttributes(Collection<T> selectedAttributes) Sets the attributes that must be selected in this dialog.
void	toBeDisplayed(boolean visible) The panel is notified that the dialog is going to be visible or invisible.

Methods inherited from class org.opends.guitools.controlpanel.ui.StatusGenericPanel

add, add, addBottomGlue, addConfigurationElementCreatedListener, addErrorPane, addErrorPane, addScheduleErrors, authenticationRequired, callConfigurationChangedInBackground, cancelClicked, checkCompatibleSuperiors, checkIntValue, checkOKButtonEnable, closeClicked, comboBoxSelected, createErrorPane, createRequiredLabel, displayBackend, displayConfirmationDialog, displayErrorDialog, displayErrorMessage, displayMainPanel, displayMessage, entryExists, getAuthenticateHTML, getConfigurationElementCreatedListeners, getInfo, getLabel, getLoginDialog, getMenuBar, getMonitoringValue, getRightPanelBorder, getScheduleArgs, getStartServerHTML, hasObjectClass, isCategory, isDisposeOnClose, isEnableCancel, isEnableClose, isEnableOK, isLocal, isServerRunning, launchOperation, launchOperation, packParentDialog, rebuildIndexIfNecessary, removeConfigurationElementCreatedListener, requiresBorder, restartServer, setDisposeOnClose, setEnabledCancel, setEnabledOK, setInfo, setPrimaryInvalid, setPrimaryValid, setSecondaryInvalid, setSecondaryValid, startServer, stopServer, updateBaseDNComboBoxModel, updateComboBoxModel, updateConfirmationPane, updateErrorPane, updateErrorPaneAndOKButtonIfAuthRequired, updateErrorPaneIfAuthRequired, updateErrorPaneIfServerRunningAndAuthRequired, updateIndexMap, updateMonitoringInfo, updateSimpleBackendComboBoxModel

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MonitoringAttributesViewPanel

protected MonitoringAttributesViewPanel(LinkedHashSet<T> attributes)

Default constructor.

Parameters:

attributes - the attributes that will be proposed to the user.

Method Detail

createStringInstance

public static MonitoringAttributesViewPanel<String> createStringInstance(LinkedHashSet<String> attributes)

Creates an instance of this panel that uses String as attributes.

Parameters:

attributes - the list of possible attributes.

Returns:

an instance of this panel that uses String as attributes.

createMonitoringAttributesInstance

public static MonitoringAttributesViewPanel<MonitoringAttributes> createMonitoringAttributesInstance(LinkedHashSet<MonitoringAttributes> attributes)

Creates an instance of this panel that uses MonitoringAttributes as attributes.

Parameters:

attributes - the list of possible attributes.

Returns:

an instance of this panel that uses MonitoringAttributes as attributes.

createMessageInstance

public static MonitoringAttributesViewPanel<LocalizableMessage> createMessageInstance(LinkedHashSet<LocalizableMessage> attributes)

Creates an instance of this panel that uses LocalizableMessage as attributes.

Parameters:

attributes - the list of possible attributes.

Returns:

an instance of this panel that uses LocalizableMessage as attributes.

requiresScroll

public boolean requiresScroll()

Tells whether this panel should be contained in a scroll pane or not.

Overrides:

requiresScroll in class StatusGenericPanel

Returns:

true if this panel should be contained in a scroll pane and false otherwise.

setSelectedAttributes

public void setSelectedAttributes(Collection<T> selectedAttributes)

Sets the attributes that must be selected in this dialog.

Parameters:

selectedAttributes - the selected attributes.

getTitle

public LocalizableMessage getTitle()

Returns the title that will be used as title of the dialog.

Specified by:

getTitle in class StatusGenericPanel

Returns:

the title that will be used as title of the dialog.

configurationChanged

public void configurationChanged(ConfigurationChangeEvent ev)

Method that is called when a change in the configuration occurred.

Parameters:

ev - the configuration change event.

getPreferredFocusComponent

public Component getPreferredFocusComponent()

Returns the component that should get the focus when the dialog that contains this panel is displayed.

Specified by:

getPreferredFocusComponent in class StatusGenericPanel

Returns:

the component that should get the focus.

toBeDisplayed

public void toBeDisplayed(boolean visible)

The panel is notified that the dialog is going to be visible or invisible.

Overrides:

toBeDisplayed in class StatusGenericPanel

Parameters:

visible - whether is going to be visible or not.

okClicked

public void okClicked()

Notification that the ok button has been clicked, the panel is in charge of doing whatever is required (close the dialog, launch a task, etc.).

Specified by:

okClicked in class StatusGenericPanel

getButtonType

public GenericDialog.ButtonType getButtonType()

Returns the buttons that the dialog where this panel is contained should display.

Overrides:

getButtonType in class StatusGenericPanel

Returns:

the buttons that the dialog where this panel is contained should display.

isCanceled

public boolean isCanceled()

Returns true if the user closed the dialog by cancelling it and false otherwise.

Returns:

true if the user closed the dialog by cancelling it and false otherwise.

getAttributes

public LinkedHashSet<T> getAttributes()

Returns the list of attributes that the user selected.

Returns:

the list of attributes that the user selected.

getMessage

protected LocalizableMessage getMessage(T attribute)

Returns the message for the provided attribute.

Parameters:

attribute - the attribute.

Returns:

the message for the provided attribute.