Package org.opends.guitools.controlpanel.ui

Class LDAPEntryPanel

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ConfigChangeListener, EntryReadListener

public class LDAPEntryPanel
extends StatusGenericPanel
implements EntryReadListener

This is the panel that contains all the different views to display an entry.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LDAPEntryPanel.View	The different views that we have to display an LDAP entry.

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

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	Description
LDAPEntryPanel()	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canDelete(DN dn)	Returns true if the provided DN corresponds to an entry that can be deleted and false otherwise.
UnsavedChangesDialog.Result	checkUnsavedChanges()	Tells whether the user chose to save the changes in the panel, to not save them or simply canceled the selection change in the tree.
void	configurationChanged(ConfigurationChangeEvent ev)	Method that is called when a change in the configuration occurred.
void	entryRead(EntryReadEvent ev)	Notifies that an entry was successfully read.
void	entryReadError(EntryReadErrorEvent ev)	Displays a message informing that an error occurred reading the entry.
GenericDialog.ButtonType	getButtonType()	Returns the buttons that the dialog where this panel is contained should display.
BrowserController	getController()	Returns the browser controller in charge of the tree.
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.
TreePath	getTreePath()	Returns the tree path associated with the node that is being displayed.
void	multipleEntriesSelected()	Displays a panel informing that multiple entries are selected.
boolean	mustCheckUnsavedChanges()	Method used to know if there are unsaved changes or not.
void	noEntrySelected()	Displays a panel informing that nothing is selected.
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	referralSolveError(DN dn, String[] referrals, BasicNodeError error)	Displays a message informing that an error occurred resolving a referral.
void	setController(BrowserController controller)	Sets the browser controller in charge of the tree.
void	setInfo(ControlPanelInfo info)	Sets the control panel info object.
void	setTreePath(TreePath treePath)	Sets the tree path associated with the node that is being displayed.
void	setView(LDAPEntryPanel.View view)	Sets the view to be displayed by this panel.

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, isBinary, isCategory, isDisposeOnClose, isEnableCancel, isEnableClose, isEnableOK, isLocal, isServerRunning, launchOperation, launchOperation, packParentDialog, rebuildIndexIfNecessary, removeConfigurationElementCreatedListener, requiresBorder, requiresScroll, restartServer, setDisposeOnClose, setEnabledCancel, setEnabledOK, setPrimaryInvalid, setPrimaryValid, setSecondaryInvalid, setSecondaryValid, startServer, stopServer, toBeDisplayed, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

LDAPEntryPanel

public LDAPEntryPanel()

Default constructor.

Method Detail

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

entryRead

public void entryRead(EntryReadEvent ev)

Description copied from interface: EntryReadListener

Notifies that an entry was successfully read.

Specified by:

entryRead in interface EntryReadListener

Parameters:

ev - the event containing the search result.

setView

public void setView(LDAPEntryPanel.View view)

Sets the view to be displayed by this panel.

Parameters:

view - the view.

entryReadError

public void entryReadError(EntryReadErrorEvent ev)

Displays a message informing that an error occurred reading the entry.

Specified by:

entryReadError in interface EntryReadListener

Parameters:

ev - the entry read error event.

referralSolveError

public void referralSolveError(DN dn,
                               String[] referrals,
                               BasicNodeError error)

Displays a message informing that an error occurred resolving a referral.

Parameters:

dn - the DN of the local entry.

referrals - the list of referrals defined in the entry.

error - the error that occurred resolving the referral.

noEntrySelected

public void noEntrySelected()

Displays a panel informing that nothing is selected.

multipleEntriesSelected

public void multipleEntriesSelected()

Displays a panel informing that multiple entries are selected.

getButtonType

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

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.

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.

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.

setInfo

public void setInfo(ControlPanelInfo info)

Description copied from class: StatusGenericPanel

Sets the control panel info object.

Overrides:

setInfo in class StatusGenericPanel

Parameters:

info - the control panel info object.

canDelete

public boolean canDelete(DN dn)

Returns true if the provided DN corresponds to an entry that can be deleted and false otherwise.

Parameters:

dn - the DN of the entry.

Returns:

true if the provided DN corresponds to an entry that can be deleted and false otherwise.

getController

public BrowserController getController()

Returns the browser controller in charge of the tree.

Returns:

the browser controller in charge of the tree.

setController

public void setController(BrowserController controller)

Sets the browser controller in charge of the tree.

Parameters:

controller - the browser controller in charge of the tree.

getTreePath

public TreePath getTreePath()

Returns the tree path associated with the node that is being displayed.

Returns:

the tree path associated with the node that is being displayed.

setTreePath

public void setTreePath(TreePath treePath)

Sets the tree path associated with the node that is being displayed.

Parameters:

treePath - the tree path associated with the node that is being displayed.

mustCheckUnsavedChanges

public boolean mustCheckUnsavedChanges()

Method used to know if there are unsaved changes or not. It is used by the entry selection listener when the user changes the selection.

Returns:

true if there are unsaved changes (and so the selection of the entry should be cancelled) and false otherwise.

checkUnsavedChanges

public UnsavedChangesDialog.Result checkUnsavedChanges()

Tells whether the user chose to save the changes in the panel, to not save them or simply canceled the selection change in the tree.

Returns:

the value telling whether the user chose to save the changes in the panel, to not save them or simply canceled the selection in the tree.