org.hkijena.jipipe.desktop.commons.components

Class JIPipeDesktopUserFriendlyErrorUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.desktop.commons.components.JIPipeDesktopFormPanel

org.hkijena.jipipe.desktop.commons.components.JIPipeDesktopUserFriendlyErrorUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JIPipeWorkbenchAccess, JIPipeDesktopWorkbenchAccess

public class JIPipeDesktopUserFriendlyErrorUI
extends JIPipeDesktopFormPanel
implements JIPipeDesktopWorkbenchAccess

Displays exceptions in a user-friendly way. Can handle JIPipeValidationRuntimeException and JIPipeValidationReport

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.desktop.commons.components.JIPipeDesktopFormPanel

JIPipeDesktopFormPanel.ContextHelpEvent, JIPipeDesktopFormPanel.ContextHelpEventEmitter, JIPipeDesktopFormPanel.ContextHelpEventListener, JIPipeDesktopFormPanel.FormPanelContentPanel, JIPipeDesktopFormPanel.FormPanelEntry, JIPipeDesktopFormPanel.GroupHeaderPanel

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.hkijena.jipipe.desktop.commons.components.JIPipeDesktopFormPanel

DOCUMENTATION_BELOW, DOCUMENTATION_EXTERNAL, DOCUMENTATION_NO_UI, NONE, TABBED_DOCUMENTATION, TRANSPARENT_BACKGROUND, WITH_DOCUMENTATION, WITH_LIMIT_WIDTH, WITH_SCROLLING

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 and Description
JIPipeDesktopUserFriendlyErrorUI(JIPipeDesktopWorkbench workbench, MarkdownText helpDocument, int flags)

Method Summary

Modifier and Type	Method and Description
void	addEntry(JIPipeValidationReportEntry entry) Adds an entry to the UI
void	clear() Removes all components
void	displayErrors(JIPipeValidationReport report) Adds a report to the display Does not add the necessary vertical glue.
void	displayErrors(Throwable e) Adds an exception to the display.
JIPipeDesktopWorkbench	getDesktopWorkbench()
JToolBar	getToolBar()
JIPipeWorkbench	getWorkbench()

Methods inherited from class org.hkijena.jipipe.desktop.commons.components.JIPipeDesktopFormPanel

addGroupHeader, addGroupHeader, addToForm, addToForm, addVerticalGlue, addVerticalGlue, addWideToForm, addWideToForm, createEntryPropertiesComponent, getContentPanel, getContextHelpEventEmitter, getDocumentationTabPane, getEntries, getFlags, getGroupHeaderPanels, getHelpPanel, getNumRows, getRedirectDocumentationTarget, getScrollPane, getStaticContentPanel, hasFlag, installComponentHighlighter, isHasVerticalGlue, isWithDocumentation, removeLastRow, setHelpPanel, setOpaque, setRedirectDocumentationTarget, showDialog, showDocumentation

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, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, 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

Constructor Detail

JIPipeDesktopUserFriendlyErrorUI

public JIPipeDesktopUserFriendlyErrorUI(JIPipeDesktopWorkbench workbench,
                                        MarkdownText helpDocument,
                                        int flags)

Parameters:

workbench - the workbench

helpDocument - the help document to be displayed. If null, no help is displayed

flags - FormPanel flags

Method Detail

getToolBar

public JToolBar getToolBar()

clear

public void clear()

Description copied from class: JIPipeDesktopFormPanel

Removes all components

Overrides:

clear in class JIPipeDesktopFormPanel

displayErrors

public void displayErrors(Throwable e)

Adds an exception to the display. Does not add the necessary vertical glue.

Parameters:

e - the exception

displayErrors

public void displayErrors(JIPipeValidationReport report)

Adds a report to the display Does not add the necessary vertical glue.

Parameters:

report - the report

addEntry

public void addEntry(JIPipeValidationReportEntry entry)

Adds an entry to the UI

Parameters:

entry - the entry

getDesktopWorkbench

public JIPipeDesktopWorkbench getDesktopWorkbench()

Specified by:

getDesktopWorkbench in interface JIPipeDesktopWorkbenchAccess

getWorkbench

public JIPipeWorkbench getWorkbench()

Specified by:

getWorkbench in interface JIPipeWorkbenchAccess