Class BasicErrorPaneUI

java.lang.Object
javax.swing.plaf.ComponentUI
javax.swing.plaf.PanelUI
org.jdesktop.swingx.plaf.ErrorPaneUI
org.jdesktop.swingx.plaf.basic.BasicErrorPaneUI
Direct Known Subclasses:
MacOSXErrorPaneUI
public class BasicErrorPaneUI extends ErrorPaneUI
Base implementation of the JXErrorPane UI.

  • Field Details

    • CLASS_NAME

      protected static final String CLASS_NAME
      Used as a prefix when pulling data out of UIManager for i18n
      See Also:

    • pane

      protected JXErrorPane pane
      The error pane this UI is for

    • errorMessage

      protected JEditorPane errorMessage
      Error message text area

    • errorScrollPane

      protected JScrollPane errorScrollPane
      Error message text scroll pane wrapper.

    • details

      protected JXEditorPane details
      details text area

    • detailButton

      protected AbstractButton detailButton
      detail button

    • closeButton

      protected JButton closeButton
      ok/close button

    • iconLabel

      protected JLabel iconLabel
      label used to display the warning/error icon

    • reportButton

      protected AbstractButton reportButton
      report an error button

    • detailsPanel

      protected JPanel detailsPanel
      details panel

    • detailsScrollPane

      protected JScrollPane detailsScrollPane

    • copyToClipboardButton

      protected JButton copyToClipboardButton

    • errorPaneListener

      protected PropertyChangeListener errorPaneListener
      Property change listener for the error pane ensures that the pane's UI is reinitialized.

    • detailListener

      protected ActionListener detailListener
      Action listener for the detail button.

    • copyToClipboardListener

      protected ActionListener copyToClipboardListener
      Action listener for the copy to clipboard button.

    • collapsedHeight

      private int collapsedHeight
      The height of the window when collapsed. This value is stashed when the dialog is expanded

    • expandedHeight

      private int expandedHeight
      The height of the window when last expanded. This value is stashed when the dialog is collapsed

  • Constructor Details

    • BasicErrorPaneUI

      public BasicErrorPaneUI()

  • Method Details

    • createUI

      public static ComponentUI createUI(JComponent c)

    • installUI

      public void installUI(JComponent c)
      Overrides:
      installUI in class ComponentUI

    • uninstallUI

      public void uninstallUI(JComponent c)
      Overrides:
      uninstallUI in class ComponentUI

    • installDefaults

      protected void installDefaults()
      Installs the default colors, and default font into the Error Pane

    • uninstallDefaults

      protected void uninstallDefaults()
      Uninstalls the default colors, and default font into the Error Pane.

    • installListeners

      protected void installListeners()
      Create and install the listeners for the Error Pane. This method is called when the UI is installed.

    • uninstallListeners

      protected void uninstallListeners()
      Remove the installed listeners from the Error Pane. The number and types of listeners removed and in this method should be the same that was added in installListeners

    • installComponents

      protected void installComponents()
      Creates and initializes the components which make up the aggregate combo box. This method is called as part of the UI installation process.

    • uninstallComponents

      protected void uninstallComponents()
      The aggregate components which compise the combo box are unregistered and uninitialized. This method is called as part of the UI uninstallation process.

    • getErrorFrame

      public JFrame getErrorFrame(Component owner)
      Description copied from class: ErrorPaneUI
      Creates new ErrorPane wrapped in the frame window centered at provided owner component.
      Specified by:
      getErrorFrame in class ErrorPaneUI
      Parameters:
      owner - component to center created error frame at.
      Returns:
      New ErrorPane instance wrapped in JFrame.

    • getErrorDialog

      public JDialog getErrorDialog(Component owner)
      Description copied from class: ErrorPaneUI
      Creates new ErrorPane wrapped in the dialog window centered at provided owner component.
      Specified by:
      getErrorDialog in class ErrorPaneUI
      Parameters:
      owner - component to center created error dialog at.
      Returns:
      New ErrorPane instance wrapped in JDialog.

    • getErrorInternalFrame

      public JInternalFrame getErrorInternalFrame(Component owner)
      Description copied from class: ErrorPaneUI
      Creates new ErrorPane wrapped in the internal frame window centered at provided owner component.
      Specified by:
      getErrorInternalFrame in class ErrorPaneUI
      Parameters:
      owner - component to center created error frame at.
      Returns:
      New ErrorPane instance wrapped in JInternalFrame.

    • createErrorPaneLayout

      protected LayoutManager createErrorPaneLayout()
      Create and return the LayoutManager to use with the error pane.

    • createDetailPanelLayout

      protected LayoutManager createDetailPanelLayout()

    • calculatePreferredSize

      public Dimension calculatePreferredSize()
      Description copied from class: ErrorPaneUI
      Calculates default prefered size for JXErrorPane on given platform/LAF.
      Specified by:
      calculatePreferredSize in class ErrorPaneUI
      Returns:
      Preferred size.

    • getDetailsHeight

      protected int getDetailsHeight()

    • configureReportAction

      protected void configureReportAction(AbstractActionExt reportAction)

    • createDetailsTransferHandler

      private TransferHandler createDetailsTransferHandler(JTextComponent detailComponent)
      Creates and returns a TransferHandler which can be used to copy the details from the details component. It also disallows pasting into the component, or cutting from the component.
      Returns:
      a TransferHandler for the details area

    • getDefaultErrorIcon

      protected Icon getDefaultErrorIcon()
      Returns:
      the default error icon

    • getDefaultWarningIcon

      protected Icon getDefaultWarningIcon()
      Returns:
      the default warning icon

    • setDetails

      private void setDetails(String details)
      Set the details section of the error dialog. If the details are either null or an empty string, then hide the details button and hide the detail scroll pane. Otherwise, just set the details section.
      Parameters:
      details - Details to be shown in the detail section of the dialog. This can be null if you do not want to display the details section of the dialog.

    • configureDetailsButton

      protected void configureDetailsButton(boolean expanded)

    • setDetailsVisible

      private void setDetailsVisible(boolean b)
      Set the details section to be either visible or invisible. Set the text of the Details button accordingly.
      Parameters:
      b - if true details section will be visible

    • setErrorMessage

      private void setErrorMessage(String errorMessage)
      Set the error message for the dialog box
      Parameters:
      errorMessage - Message for the error dialog

    • reinit

      protected void reinit()
      Reconfigures the dialog if settings have changed, such as the errorInfo, errorIcon, warningIcon, etc

    • getDetailsAsHTML

      protected String getDetailsAsHTML(ErrorInfo errorInfo)
      Creates and returns HTML representing the details of this incident info. This method is only called if the details needs to be generated: ie: the detailed error message property of the incident info is null.

    • initWindow

      private void initWindow(Window w, JXErrorPane pane)
      Utility method for initializing a Window for displaying a JXErrorPane. This is particularly useful because the differences between JFrame and JDialog are so minor. removed.

    • exitIfFatal

      private void exitIfFatal()

    • centerWindow

      private static void centerWindow(Window w, Component owner)

    • centerWindow

      private static void centerWindow(JInternalFrame w, Component owner)

    • escapeXml

      private static String escapeXml(String input)
      Converts the incoming string to an escaped output string. This method is far from perfect, only escaping <, > and & characters