org.opends.guitools.controlpanel.ui

Class LDAPEntrySelectionPanel

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

org.opends.guitools.controlpanel.ui.LDAPEntrySelectionPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, BackendPopulatedListener, ConfigChangeListener

public class LDAPEntrySelectionPanel
extends AbstractBrowseEntriesPanel

A basic panel that contains a browser. It is used in general in panels that require to provide some DNs of existing entries: we allow the user to launch a browser to select entries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPEntrySelectionPanel.Filter The values of the filters that will be used when opening the dialog where this panel is contained.

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

AbstractBrowseEntriesPanel.NumberOfEntriesUpdater

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

controller, filter, filterAttribute, GROUP_FILTER, LDAP_FILTER, treePane, USER_FILTER

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

Constructor and Description
LDAPEntrySelectionPanel() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Component	createMainPanel() Returns the component that will be displayed between the filtering options and the buttons panel.
GenericDialog.ButtonType	getBrowseButtonType() Since these panel has a special layout, we cannot use the layout of the GenericDialog and we return ButtonType.NO_BUTTON in the method getButtonType.
String[]	getDNs() Returns the selected DN's in an array of Strings.
LDAPEntrySelectionPanel.Filter	getFilter() Returns the last filter set with the setFilter method.
LocalizableMessage	getTitle() Returns the title that will be used as title of the dialog.
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.).
void	setFilter(LDAPEntrySelectionPanel.Filter filter) Sets the filter to be used when the panel is displayed.
void	setMultipleSelection(boolean multiple) Updates the tree selection model to allow multiple selection or not.
void	setTitle(LocalizableMessage title) Sets the title that will be displayed in the dialog containing this panel.
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.AbstractBrowseEntriesPanel

applyButtonClicked, backendPopulated, callConfigurationChangedInBackground, cancelClicked, configurationChanged, createBrowserController, createTreePane, getButtonType, getPreferredFocusComponent, requiresBorder, requiresScroll, setEnabledCancel, setEnabledOK, setInfo

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

add, add, addBottomGlue, addConfigurationElementCreatedListener, addErrorPane, addErrorPane, addScheduleErrors, authenticationRequired, 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, restartServer, setDisposeOnClose, 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

LDAPEntrySelectionPanel

public LDAPEntrySelectionPanel()

Default constructor.

Method Detail

setMultipleSelection

public void setMultipleSelection(boolean multiple)

Updates the tree selection model to allow multiple selection or not.

Parameters:

multiple - whether the tree should allow multiple selection or not.

toBeDisplayed

public void toBeDisplayed(boolean visible)

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

Overrides:

toBeDisplayed in class AbstractBrowseEntriesPanel

Parameters:

visible - whether is going to be visible or not.

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.

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

getDNs

public String[] getDNs()

Returns the selected DN's in an array of Strings. The array is never null but might be empty.

Returns:

the selected DN's.

getBrowseButtonType

public GenericDialog.ButtonType getBrowseButtonType()

Since these panel has a special layout, we cannot use the layout of the GenericDialog and we return ButtonType.NO_BUTTON in the method getButtonType. We use this method to be able to add some progress information to the left of the buttons.

Specified by:

getBrowseButtonType in class AbstractBrowseEntriesPanel

Returns:

the button type of the panel.

createMainPanel

protected Component createMainPanel()

Returns the component that will be displayed between the filtering options and the buttons panel. This component must contain the tree panel.

Specified by:

createMainPanel in class AbstractBrowseEntriesPanel

Returns:

the component that will be displayed between the filtering options and the buttons panel.

getFilter

public LDAPEntrySelectionPanel.Filter getFilter()

Returns the last filter set with the setFilter method.

Returns:

the last filter set with the setFilter method.

setFilter

public void setFilter(LDAPEntrySelectionPanel.Filter filter)

Sets the filter to be used when the panel is displayed.

Parameters:

filter - the filter.

setTitle

public void setTitle(LocalizableMessage title)

Sets the title that will be displayed in the dialog containing this panel.

Parameters:

title - the title.