org.opends.guitools.controlpanel.ui

Class BrowseEntriesPanel

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, BackendPopulatedListener, ConfigChangeListener

public class BrowseEntriesPanel
extends StatusGenericPanel

The pane that is displayed when the user clicks on 'Browse Entries...'. It contains its own menu bar with all the actions to edit the entries.

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

Modifier and Type	Field and Description
protected BrowserController	controller The browser controller used to update the LDAP entry tree.
protected FilterTextField	filter The text field of the filter.
protected JComboBox<CharSequence>	filterAttribute The combo box containing the different filter types.
protected static org.forgerock.i18n.LocalizableMessage	GROUP_FILTER Group filter message.
protected static org.forgerock.i18n.LocalizableMessage	LDAP_FILTER LDAP filter message.
protected TreePanel	treePane The tree pane contained in this panel.
protected static org.forgerock.i18n.LocalizableMessage	USER_FILTER User filter message.

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

COMBO_SEPARATOR, errorPane, NOT_APPLICABLE

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
BrowseEntriesPanel()

Method Summary

Modifier and Type	Method and Description
protected void	applyButtonClicked() The method that is called when the user clicks on Apply.
void	backendPopulated(BackendPopulatedEvent ev) Method called when a set of backends are populated.
boolean	callConfigurationChangedInBackground() This method is called to indicate that the configuration changes should be called in the background.
void	cancelClicked() Notification that cancel was clicked, the panel is in charge of doing whatever is required (close the dialog, etc.).
void	configurationChanged(ConfigurationChangeEvent ev) Method that is called when a change in the configuration occurred.
protected void	createBrowserController(ControlPanelInfo info) Creates the browser controller object.
protected Component	createMainPanel() Returns the component that will be displayed between the filtering options and the buttons panel.
protected JComponent	createTreePane() Creates and returns the tree 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.
GenericDialog.ButtonType	getButtonType() Returns the buttons that the dialog where this panel is contained should display.
JMenuBar	getMenuBar() Returns the menu bar that the panel might have.
Component	getPreferredFocusComponent() Returns the component that should get the focus when the dialog that contains this panel is displayed.
org.forgerock.i18n.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.).
boolean	requiresBorder() Returns true if this panel requires some bordering (in general an EmptyBorder with some insets) and false otherwise.
boolean	requiresScroll() Tells whether this panel should be contained in a scroll pane or not.
protected void	setEnabledCancel(boolean enable) Enables the Cancel button in the parent dialog.
protected void	setEnabledOK(boolean enable) Enables the OK button in the parent dialog.
void	setInfo(ControlPanelInfo info) Sets the control panel info object.
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, checkCompatibleSuperiors, checkIntValue, checkOKButtonEnable, closeClicked, comboBoxSelected, createErrorPane, createRequiredLabel, displayBackend, displayConfirmationDialog, displayErrorDialog, displayErrorMessage, displayMainPanel, displayMessage, entryExists, getAuthenticateHTML, getConfigurationElementCreatedListeners, getInfo, getLabel, getLoginDialog, getMonitoringValue, getRightPanelBorder, getScheduleArgs, getStartServerHTML, hasObjectClass, isBinary, 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

Field Detail

LDAP_FILTER

protected static final org.forgerock.i18n.LocalizableMessage LDAP_FILTER

LDAP filter message.

USER_FILTER

protected static final org.forgerock.i18n.LocalizableMessage USER_FILTER

User filter message.

GROUP_FILTER

protected static final org.forgerock.i18n.LocalizableMessage GROUP_FILTER

Group filter message.

filterAttribute

protected JComboBox<CharSequence> filterAttribute

The combo box containing the different filter types.

filter

protected FilterTextField filter

The text field of the filter.

treePane

protected TreePanel treePane

The tree pane contained in this panel.

controller

protected BrowserController controller

The browser controller used to update the LDAP entry tree.

Constructor Detail

BrowseEntriesPanel

public BrowseEntriesPanel()

Method Detail

getMenuBar

public JMenuBar getMenuBar()

Description copied from class: StatusGenericPanel

Returns the menu bar that the panel might have. Returns null if the panel has no menu bar associated.

Overrides:

getMenuBar in class StatusGenericPanel

Returns:

the menu bar that the panel might have.

getTitle

public org.forgerock.i18n.LocalizableMessage getTitle()

Description copied from class: StatusGenericPanel

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.

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.

Returns:

the button type of the panel.

createBrowserController

protected void createBrowserController(ControlPanelInfo info)

Creates the browser controller object.

Parameters:

info - the ControlPanelInfo to be used to create the browser controller.

okClicked

public void okClicked()

Description copied from class: StatusGenericPanel

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

toBeDisplayed

public void toBeDisplayed(boolean visible)

Description copied from class: StatusGenericPanel

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

Parameters:

visible - whether is going to be visible or not.

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.

Returns:

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

setInfo

public void setInfo(ControlPanelInfo info)

Description copied from class: StatusGenericPanel

Sets the control panel info object.

Parameters:

info - the control panel info object.

configurationChanged

public void configurationChanged(ConfigurationChangeEvent ev)

Description copied from interface: ConfigChangeListener

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

Specified by:

configurationChanged in interface ConfigChangeListener

Parameters:

ev - the configuration change event.

requiresBorder

public boolean requiresBorder()

Description copied from class: StatusGenericPanel

Returns true if this panel requires some bordering (in general an EmptyBorder with some insets) and false otherwise.

Overrides:

requiresBorder in class StatusGenericPanel

Returns:

true if this panel requires some bordering (in general an EmptyBorder with some insets) and false otherwise.

requiresScroll

public boolean requiresScroll()

Description copied from class: StatusGenericPanel

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.

callConfigurationChangedInBackground

public boolean callConfigurationChangedInBackground()

Description copied from class: StatusGenericPanel

This method is called to indicate that the configuration changes should be called in the background. In the case of panels which require some time to be updated with the new configuration this method returns true and the operation will be performed in the background while a message of type 'Loading...' is displayed on the panel.

Overrides:

callConfigurationChangedInBackground in class StatusGenericPanel

Returns:

true if changes should be loaded in the background and false otherwise.

getButtonType

public final GenericDialog.ButtonType getButtonType()

Description copied from class: StatusGenericPanel

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.

setEnabledOK

protected void setEnabledOK(boolean enable)

Description copied from class: StatusGenericPanel

Enables the OK button in the parent dialog.

Overrides:

setEnabledOK in class StatusGenericPanel

Parameters:

enable - whether to enable or disable the button.

setEnabledCancel

protected void setEnabledCancel(boolean enable)

Description copied from class: StatusGenericPanel

Enables the Cancel button in the parent dialog.

Overrides:

setEnabledCancel in class StatusGenericPanel

Parameters:

enable - whether to enable or disable the button.

getPreferredFocusComponent

public Component getPreferredFocusComponent()

Description copied from class: StatusGenericPanel

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.

cancelClicked

public void cancelClicked()

Description copied from class: StatusGenericPanel

Notification that cancel was clicked, the panel is in charge of doing whatever is required (close the dialog, etc.).

Overrides:

cancelClicked in class StatusGenericPanel

applyButtonClicked

protected void applyButtonClicked()

The method that is called when the user clicks on Apply. Basically it will update the BrowserController with the new base DN and filter specified by the user. The method assumes that is being called from the event thread.

backendPopulated

public void backendPopulated(BackendPopulatedEvent ev)

Description copied from interface: BackendPopulatedListener

Method called when a set of backends are populated.

Specified by:

backendPopulated in interface BackendPopulatedListener

Parameters:

ev - the event notifying that a set of backends have been populated.

createTreePane

protected JComponent createTreePane()

Creates and returns the tree panel.

Returns:

the tree panel.