org.opends.guitools.controlpanel.ui

Class ViewEntryPanel

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ConfigChangeListener

Direct Known Subclasses:

LDIFViewEntryPanel, SimplifiedViewEntryPanel, TableViewEntryPanel

public abstract class ViewEntryPanel
extends StatusGenericPanel

Abstract class containing code shared by the different LDAP entry view panels (Simplified View, Attribute View and LDIF View).

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 static boolean	displayOnlyWithAttrs Static boolean used to know whether only attributes with values should be displayed or not.
protected SortedSet<String>	editableOperationalAttrNames The editable operational attributes.
protected boolean	ignoreEntryChangeEvents Whether the entry change events should be ignored or not.
protected SortedSet<String>	schemaReadOnlyAttributes The read-only attributes as they appear on the schema.
protected SortedSet<String>	schemaReadOnlyAttributesLowerCase The read-only attributes in lower case.

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
ViewEntryPanel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLDAPEntryChangedListener(LDAPEntryChangedListener listener) Adds an LDAP entry change listener.
protected void	addTitlePanel(Container c, GridBagConstraints gbc) Adds a title panel to the container.
protected void	addValuesInRDN(Entry entry) Adds the values in the RDN to the entry definition.
protected void	appendLDIFLine(StringBuilder sb, String attrName, Object value) Appends the LDIF line corresponding to the value of an attribute to the provided StringBuilder.
protected void	appendLDIFLines(StringBuilder sb, String attrName, List<Object> values) Appends the LDIF lines corresponding to the different values of an attribute to the provided StringBuilder.
protected boolean	checkSchema() Whether the schema must be checked or not.
void	configurationChanged(ConfigurationChangeEvent ev) Method that is called when a change in the configuration occurred.
protected abstract String	getDisplayedDN() Returns the DN of the entry that the user is editing (it might differ from the DN of the entry in the tree if the user modified the DN).
abstract Entry	getEntry() Returns an Entry object representing what the panel is displaying.
protected ObjectClassValue	getObjectClassDescriptor(List<Object> ocValues, Schema schema) Returns an object class value representing all the object class values of the entry.
protected Set<String>	getObjectClassSuperiorValues(ObjectClass oc) Returns the list of superior object classes (to top) for a given object class.
LocalizableMessage	getTitle() Returns the title that will be used as title of the dialog.
protected abstract List<Object>	getValues(String attrName) Gets the values associated with a given attribute.
protected boolean	hasCertificateSyntax(String attrName, Schema schema) Returns true if the provided attribute name has certificate syntax and false otherwise.
protected boolean	isBinary(String attrName) Returns true if the provided attribute name has binary syntax and false otherwise.
static boolean	isEditable(String attrName, Schema schema) Returns true if the provided attribute name is an editable attribute and false otherwise.
protected boolean	isPassword(String attrName) Returns true if the provided attribute name has password syntax and false otherwise.
protected void	notifyListeners() Notifies the entry changed listeners that the entry changed.
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	removeLDAPEntryChangedListener(LDAPEntryChangedListener listener) Removes an LDAP entry change listener.
boolean	requiresBorder() Returns true if this panel requires some bordering (in general an EmptyBorder with some insets) and false otherwise.
protected void	setValues(CustomSearchResult sr, String attrName) Sets the values displayed in the panel for a given attribute in the provided search result.
abstract void	update(CustomSearchResult sr, boolean isReadOnly, TreePath path) Updates the contents of the panel.
protected void	updateTitle(CustomSearchResult sr, TreePath path) Updates the title panel with the provided entry.

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, getButtonType, getConfigurationElementCreatedListeners, getInfo, getLabel, getLoginDialog, getMenuBar, getMonitoringValue, getPreferredFocusComponent, getRightPanelBorder, getScheduleArgs, getStartServerHTML, hasObjectClass, isCategory, isDisposeOnClose, isEnableCancel, isEnableClose, isEnableOK, isLocal, isServerRunning, launchOperation, launchOperation, packParentDialog, rebuildIndexIfNecessary, removeConfigurationElementCreatedListener, requiresScroll, restartServer, setDisposeOnClose, setEnabledCancel, setEnabledOK, setInfo, 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, 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

schemaReadOnlyAttributes

protected SortedSet<String> schemaReadOnlyAttributes

The read-only attributes as they appear on the schema.

schemaReadOnlyAttributesLowerCase

protected SortedSet<String> schemaReadOnlyAttributesLowerCase

The read-only attributes in lower case.

editableOperationalAttrNames

protected SortedSet<String> editableOperationalAttrNames

The editable operational attributes.

ignoreEntryChangeEvents

protected boolean ignoreEntryChangeEvents

Whether the entry change events should be ignored or not.

displayOnlyWithAttrs

protected static boolean displayOnlyWithAttrs

Static boolean used to know whether only attributes with values should be displayed or not.

Constructor Detail

ViewEntryPanel

public ViewEntryPanel()

Method Detail

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

getEntry

public abstract Entry getEntry()
                        throws OpenDsException

Returns an Entry object representing what the panel is displaying.

Returns:

an Entry object representing what the panel is displaying.

Throws:

OpenDsException - if the entry cannot be generated (in particular if the user provided invalid data).

update

public abstract void update(CustomSearchResult sr,
          boolean isReadOnly,
          TreePath path)

Updates the contents of the panel.

Parameters:

sr - the search result to be used to update the panel.

isReadOnly - whether the entry is read-only or not.

path - the tree path associated with the entry in the tree.

addTitlePanel

protected void addTitlePanel(Container c,
                 GridBagConstraints gbc)

Adds a title panel to the container.

Parameters:

c - the container where the title panel must be added.

gbc - the grid bag constraints to be used.

checkSchema

protected boolean checkSchema()

Whether the schema must be checked or not.

Returns:

true if the server is configured to check schema and false otherwise.

addLDAPEntryChangedListener

public void addLDAPEntryChangedListener(LDAPEntryChangedListener listener)

Adds an LDAP entry change listener.

Parameters:

listener - the listener.

removeLDAPEntryChangedListener

public void removeLDAPEntryChangedListener(LDAPEntryChangedListener listener)

Removes an LDAP entry change listener.

Parameters:

listener - the listener.

requiresBorder

public boolean requiresBorder()

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.

getDisplayedDN

protected abstract String getDisplayedDN()

Returns the DN of the entry that the user is editing (it might differ from the DN of the entry in the tree if the user modified the DN).

Returns:

the DN of the entry that the user is editing.

notifyListeners

protected void notifyListeners()

Notifies the entry changed listeners that the entry changed.

updateTitle

protected void updateTitle(CustomSearchResult sr,
               TreePath path)

Updates the title panel with the provided entry.

Parameters:

sr - the search result.

path - the path to the node of the entry selected in the tree. Used to display the same icon as in the tree.

getObjectClassDescriptor

protected ObjectClassValue getObjectClassDescriptor(List<Object> ocValues,
                                        Schema schema)

Returns an object class value representing all the object class values of the entry.

Parameters:

ocValues - the list of object class values.

schema - the schema.

Returns:

an object class value representing all the object class values of the entry.

addValuesInRDN

protected void addValuesInRDN(Entry entry)

Adds the values in the RDN to the entry definition.

Parameters:

entry - the entry to be updated.

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.

appendLDIFLines

protected void appendLDIFLines(StringBuilder sb,
                   String attrName,
                   List<Object> values)

Appends the LDIF lines corresponding to the different values of an attribute to the provided StringBuilder.

Parameters:

sb - the StringBuilder that must be updated.

attrName - the attribute name.

values - the attribute values.

appendLDIFLine

protected void appendLDIFLine(StringBuilder sb,
                  String attrName,
                  Object value)

Appends the LDIF line corresponding to the value of an attribute to the provided StringBuilder.

Parameters:

sb - the StringBuilder that must be updated.

attrName - the attribute name.

value - the attribute value.

isBinary

protected boolean isBinary(String attrName)

Returns true if the provided attribute name has binary syntax and false otherwise.

Parameters:

attrName - the attribute name.

Returns:

true if the provided attribute name has binary syntax and false otherwise.

isPassword

protected boolean isPassword(String attrName)

Returns true if the provided attribute name has password syntax and false otherwise.

Parameters:

attrName - the attribute name.

Returns:

true if the provided attribute name has password syntax and false otherwise.

hasCertificateSyntax

protected boolean hasCertificateSyntax(String attrName,
                           Schema schema)

Returns true if the provided attribute name has certificate syntax and false otherwise.

Parameters:

attrName - the attribute name.

schema - the schema.

Returns:

true if the provided attribute name has certificate syntax and false otherwise.

getValues

protected abstract List<Object> getValues(String attrName)

Gets the values associated with a given attribute. The values are the ones displayed in the panel.

Parameters:

attrName - the attribute name.

Returns:

the values associated with a given attribute.

setValues

protected void setValues(CustomSearchResult sr,
             String attrName)

Sets the values displayed in the panel for a given attribute in the provided search result.

Parameters:

sr - the search result to be updated.

attrName - the attribute name.

isEditable

public static boolean isEditable(String attrName,
                 Schema schema)

Returns true if the provided attribute name is an editable attribute and false otherwise.

Parameters:

attrName - the attribute name.

schema - the schema.

Returns:

true if the provided attribute name is an editable attribute and false otherwise.

getObjectClassSuperiorValues

protected Set<String> getObjectClassSuperiorValues(ObjectClass oc)

Returns the list of superior object classes (to top) for a given object class.

Parameters:

oc - the object class.

Returns:

the set of superior object classes for a given object classes.