Package org.opends.quicksetup.ui

Class QuickSetupStepPanel

    • Constructor Detail

      • QuickSetupStepPanel

        public QuickSetupStepPanel​(GuiApplication application)
        Creates a default instance.
        Parameters:
        application - Application this panel represents

    • Method Detail

      • initialize

        public void initialize()
        Initializes this panel. Called soon after creation. In general this is where maps should be populated etc.

      • beginDisplay

        public void beginDisplay​(UserData data)
        Called just before the panel is shown: used to update the contents of the panel with new UserData (used in particular in the review panel).
        Parameters:
        data - the new user data.

      • endDisplay

        public void endDisplay()
        Called just after the panel is shown: used to set focus properly.

      • blockingBeginDisplay

        public boolean blockingBeginDisplay()
        Tells whether the method beginDisplay can be long and so should be called outside the event thread.
        Returns:
        true if the method beginDisplay can be long and so should be called outside the event thread and true otherwise.

      • displayProgress

        public void displayProgress​(ProgressDescriptor descriptor)
        Called when a progress change must be reflected in the panels. Only ProgressPanel overwrites this method and for all the others it stays empty.
        Parameters:
        descriptor - the descriptor of the Installation progress.

      • hyperlinkUpdate

        public void hyperlinkUpdate​(HyperlinkEvent e)
        Implements HyperlinkListener. When the user clicks on a link we will try to display the associated URL in the browser of the user.
        Specified by:
        hyperlinkUpdate in interface HyperlinkListener
        Parameters:
        e - the HyperlinkEvent.

      • getFieldValue

        public Object getFieldValue​(FieldName fieldName)
        Returns the value corresponding to the provided FieldName.
        Parameters:
        fieldName - the FieldName for which we want to obtain the value.
        Returns:
        the value corresponding to the provided FieldName.

      • displayFieldInvalid

        public void displayFieldInvalid​(FieldName fieldName,
                                boolean invalid)
        Marks as invalid (or valid depending on the value of the invalid parameter) a field corresponding to FieldName. This basically implies udpating the style of the JLabel associated with fieldName (the association is done using the LabelFieldDescriptor class).
        Parameters:
        fieldName - the FieldName to be marked as valid or invalid.
        invalid - whether to mark the field as valid or invalid.

      • getMinimumWidth

        public int getMinimumWidth()
        Returns the minimum width of the panel. This is used to calculate the minimum width of the dialog.
        Returns:
        the minimum width of the panel.

      • getMinimumHeight

        public int getMinimumHeight()
        Returns the minimum height of the panel. This is used to calculate the minimum height of the dialog.
        Returns:
        the minimum height of the panel.

      • addButtonActionListener

        public void addButtonActionListener​(ButtonActionListener l)
        Adds a button listener. All the button listeners will be notified when the buttons are clicked (by the user or programatically).
        Parameters:
        l - the ButtonActionListener to be added.

      • removeButtonActionListener

        public void removeButtonActionListener​(ButtonActionListener l)
        Removes a button listener.
        Parameters:
        l - the ButtonActionListener to be removed.

      • setCheckingVisible

        public void setCheckingVisible​(boolean visible)
        This method displays a working progress icon in the panel.
        Parameters:
        visible - whether the icon must be displayed or not.

      • getTextForIcon

        protected org.forgerock.i18n.LocalizableMessage getTextForIcon​(UIFactory.IconType iconType)
        Returns the text to be displayed in the progress label for a give icon type.
        Parameters:
        iconType - the icon type.
        Returns:
        the text to be displayed in the progress label for a give icon type.

      • notifyButtonListeners

        protected void notifyButtonListeners​(ButtonEvent ev)
        Notifies the button action listeners that an event occurred.
        Parameters:
        ev - the button event to be notified.

      • createInputPanel

        protected abstract Component createInputPanel()
        Creates and returns the panel that contains the layout specific to the panel.
        Returns:
        the panel that contains the layout specific to the panel.

      • getTitle

        protected abstract org.forgerock.i18n.LocalizableMessage getTitle()
        Returns the title of this panel.
        Returns:
        the title of this panel.

      • getInstructions

        protected abstract org.forgerock.i18n.LocalizableMessage getInstructions()
        Returns the instruction of this panel.
        Returns:
        the instruction of this panel.

      • addVerticalGlue

        protected void addVerticalGlue​(JPanel panel)
        Commodity method that adds a vertical glue at the bottom of a given panel.
        Parameters:
        panel - the panel to which we want to add a vertical glue.

      • urlWorkerFinished

        public void urlWorkerFinished​(URLWorker worker)
        This method is called by the URLWorker when it has finished its task.
        Parameters:
        worker - the URLWorker that finished its task.

      • requiresScroll

        protected boolean requiresScroll()
        Tells whether the input panel should have a scroll or not.
        Returns:
        true if the input panel should have a scroll and false otherwise.

      • createInstructionsPanel

        protected Component createInstructionsPanel()
        Creates and returns the instructions panel.
        Returns:
        the instructions panel.

      • getQuickSetup

        protected QuickSetup getQuickSetup()
        Gets the instance of QuickSetup acting as controller.
        Returns:
        QuickSetup instance

      • getMainWindow

        public Component getMainWindow()
        Returns the frame or window containing this panel.
        Returns:
        the frame or window containing this panel.

      • getApplication

        protected GuiApplication getApplication()
        Gets the application this panel represents.
        Returns:
        GuiApplication this panel represents