Package org.opends.guitools.controlpanel.ui

Class LDAPEntrySelectionPanel

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

      • 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

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

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

      • 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

      • 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.
        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.
        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​(org.forgerock.i18n.LocalizableMessage title)
        Sets the title that will be displayed in the dialog containing this panel.
        Parameters:
        title - the title.

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

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

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

      • createTreePane

        protected JComponent createTreePane()
        Creates and returns the tree panel.
        Returns:
        the tree panel.

      • createBrowserController

        protected void createBrowserController​(ControlPanelInfo info)
        Creates the browser controller object.
        Parameters:
        info - the ControlPanelInfo to be used to create the browser controller.