org.hkijena.jipipe.desktop.commons.components

Class JIPipeDesktopFormPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

JIPipeDesktopMessagePanel, JIPipeDesktopParameterFormPanel, JIPipeDesktopUserFriendlyErrorUI

public class JIPipeDesktopFormPanel
extends JPanel

Organizes UI in a form layout with integrated help functionality, and grouping with conditional visibility

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDesktopFormPanel.ContextHelpEvent Event triggered when the user triggers a hover-help
static class	JIPipeDesktopFormPanel.ContextHelpEventEmitter
static interface	JIPipeDesktopFormPanel.ContextHelpEventListener
static class	JIPipeDesktopFormPanel.FormPanelContentPanel
static class	JIPipeDesktopFormPanel.FormPanelEntry
static class	JIPipeDesktopFormPanel.GroupHeaderPanel Panel that contains a group header

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
static int	DOCUMENTATION_BELOW Flag that indicates that documentation should be shown below if enabled.
static int	DOCUMENTATION_EXTERNAL Flag that makes the documentation panel not appear in the split pane
static int	DOCUMENTATION_NO_UI Flag that indicates that documentation should be supported, but there should be no dedicated panel
static int	NONE Flag that indicates no modifications, meaning (1) No documentation, and (2) no scrolling
static int	TABBED_DOCUMENTATION Puts the documentation into a JIPipeDesktopTabPane if WITH_DOCUMENTATION is active
static int	TRANSPARENT_BACKGROUND Flag that makes the backgrounds of the components transparent (non-opaque) if possible
static int	WITH_DOCUMENTATION Flag that indicates that a documentation panel is shown.
static int	WITH_LIMIT_WIDTH Flag that makes the form panel limit the width of components
static int	WITH_SCROLLING Flag that makes the content be wrapped in a JScrollPane

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
JIPipeDesktopFormPanel(int flags)
JIPipeDesktopFormPanel(MarkdownText document, int flags) Creates a new instance

Method Summary

Modifier and Type	Method and Description
JIPipeDesktopFormPanel.GroupHeaderPanel	addGroupHeader(String text, Icon icon) Adds a group header
JIPipeDesktopFormPanel.GroupHeaderPanel	addGroupHeader(String text, String description, boolean collapseDescription, Icon icon) Adds a group header
<T extends Component> T	addToForm(T component, Component description) Adds a component to the form
<T extends Component> T	addToForm(T component, Component description, MarkdownText documentation) Adds a component to the form
void	addVerticalGlue() Adds a component that acts as Box.verticalGlue()
void	addVerticalGlue(Component component, MarkdownText document) Adds a vertical glue component
<T extends Component> T	addWideToForm(T component) Adds a component.
<T extends Component> T	addWideToForm(T component, MarkdownText documentation) Adds a component.
void	clear() Removes all components
protected Component	createEntryPropertiesComponent(Component component, Component description, int row, MarkdownText documentation)
org.jdesktop.swingx.JXPanel	getContentPanel()
JIPipeDesktopFormPanel.ContextHelpEventEmitter	getContextHelpEventEmitter()
JIPipeDesktopTabPane	getDocumentationTabPane()
List<JIPipeDesktopFormPanel.FormPanelEntry>	getEntries()
int	getFlags()
List<JIPipeDesktopFormPanel.GroupHeaderPanel>	getGroupHeaderPanels()
JIPipeDesktopFormHelpPanel	getHelpPanel()
int	getNumRows()
JIPipeDesktopFormPanel	getRedirectDocumentationTarget()
JScrollPane	getScrollPane()
JPanel	getStaticContentPanel() The panel that surrounds the scroll pane or content panel
boolean	hasFlag(int flag)
void	installComponentHighlighter(JComponent triggerComponent, Set<Component> targetComponents)
boolean	isHasVerticalGlue()
boolean	isWithDocumentation()
void	removeLastRow() Removes the last row.
void	setHelpPanel(JIPipeDesktopFormHelpPanel helpPanel)
void	setOpaque(boolean isOpaque)
void	setRedirectDocumentationTarget(JIPipeDesktopFormPanel redirectDocumentationTarget)
static boolean	showDialog(Component parent, JIPipeDesktopFormPanel formPanel, String title) Shows a parameter collection inside a modal dialog
void	showDocumentation(MarkdownText documentation)

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

Field Detail

NONE

public static final int NONE

Flag that indicates no modifications, meaning (1) No documentation, and (2) no scrolling

See Also:

Constant Field Values

WITH_DOCUMENTATION

public static final int WITH_DOCUMENTATION

Flag that indicates that a documentation panel is shown. The documentation panel is attached on the right-hand side. Use DOCUMENTATION_BELOW to move it below the contents. The documentation panel is shown even if the documentation provided in the constructor is null.

See Also:

Constant Field Values

DOCUMENTATION_NO_UI

public static final int DOCUMENTATION_NO_UI

Flag that indicates that documentation should be supported, but there should be no dedicated panel

See Also:

Constant Field Values

TRANSPARENT_BACKGROUND

public static final int TRANSPARENT_BACKGROUND

Flag that makes the backgrounds of the components transparent (non-opaque) if possible

See Also:

Constant Field Values

WITH_LIMIT_WIDTH

public static final int WITH_LIMIT_WIDTH

Flag that makes the form panel limit the width of components

See Also:

Constant Field Values

DOCUMENTATION_EXTERNAL

public static final int DOCUMENTATION_EXTERNAL

Flag that makes the documentation panel not appear in the split pane

See Also:

Constant Field Values

WITH_SCROLLING

public static final int WITH_SCROLLING

Flag that makes the content be wrapped in a JScrollPane

See Also:

Constant Field Values

DOCUMENTATION_BELOW

public static final int DOCUMENTATION_BELOW

Flag that indicates that documentation should be shown below if enabled. This does not enable documentation! Use WITH_DOCUMENTATION for this.

See Also:

Constant Field Values

TABBED_DOCUMENTATION

public static final int TABBED_DOCUMENTATION

Puts the documentation into a JIPipeDesktopTabPane if WITH_DOCUMENTATION is active

See Also:

Constant Field Values

Constructor Detail

JIPipeDesktopFormPanel

public JIPipeDesktopFormPanel(int flags)

JIPipeDesktopFormPanel

public JIPipeDesktopFormPanel(MarkdownText document,
                              int flags)

Creates a new instance

Parameters:

document - optional documentation

flags - flags for this component

Method Detail

showDialog

public static boolean showDialog(Component parent,
                                 JIPipeDesktopFormPanel formPanel,
                                 String title)

Shows a parameter collection inside a modal dialog

Returns:

if the user clicked "OK"

getGroupHeaderPanels

public List<JIPipeDesktopFormPanel.GroupHeaderPanel> getGroupHeaderPanels()

getFlags

public int getFlags()

hasFlag

public boolean hasFlag(int flag)

getStaticContentPanel

public JPanel getStaticContentPanel()

The panel that surrounds the scroll pane or content panel

Returns:

the static content panel

getDocumentationTabPane

public JIPipeDesktopTabPane getDocumentationTabPane()

getRedirectDocumentationTarget

public JIPipeDesktopFormPanel getRedirectDocumentationTarget()

setRedirectDocumentationTarget

public void setRedirectDocumentationTarget(JIPipeDesktopFormPanel redirectDocumentationTarget)

getHelpPanel

public JIPipeDesktopFormHelpPanel getHelpPanel()

setHelpPanel

public void setHelpPanel(JIPipeDesktopFormHelpPanel helpPanel)

isWithDocumentation

public boolean isWithDocumentation()

isHasVerticalGlue

public boolean isHasVerticalGlue()

getContextHelpEventEmitter

public JIPipeDesktopFormPanel.ContextHelpEventEmitter getContextHelpEventEmitter()

setOpaque

public void setOpaque(boolean isOpaque)

Overrides:

setOpaque in class JComponent

getContentPanel

public org.jdesktop.swingx.JXPanel getContentPanel()

getScrollPane

public JScrollPane getScrollPane()

addToForm

public <T extends Component> T addToForm(T component,
                                         Component description)

Adds a component to the form

Type Parameters:

T - Component type

Parameters:

component - The component

description - A description component displayed on the left hand side

Returns:

The component

addToForm

public <T extends Component> T addToForm(T component,
                                         Component description,
                                         MarkdownText documentation)

Adds a component to the form

Type Parameters:

T - Component type

Parameters:

component - The component

description - A description component displayed on the left hand side

documentation - Optional documentation for this component. Can be null.

Returns:

The component

addWideToForm

public <T extends Component> T addWideToForm(T component)

Adds a component. Its size is two columns.

Type Parameters:

T - Component type

Parameters:

component - The component

Returns:

The component

addWideToForm

public <T extends Component> T addWideToForm(T component,
                                             MarkdownText documentation)

Adds a component. Its size is two columns.

Type Parameters:

T - Component type

Parameters:

component - The component

documentation - Optional documentation. Can be null.

Returns:

The component

showDocumentation

public void showDocumentation(MarkdownText documentation)

createEntryPropertiesComponent

protected Component createEntryPropertiesComponent(Component component,
                                                   Component description,
                                                   int row,
                                                   MarkdownText documentation)

getNumRows

public int getNumRows()

addGroupHeader

public JIPipeDesktopFormPanel.GroupHeaderPanel addGroupHeader(String text,
                                                              Icon icon)

Adds a group header

Parameters:

text - Group text

icon - Group icon

Returns:

the panel that allows adding more components to it

addGroupHeader

public JIPipeDesktopFormPanel.GroupHeaderPanel addGroupHeader(String text,
                                                              String description,
                                                              boolean collapseDescription,
                                                              Icon icon)

Adds a group header

Parameters:

text - Group text

description - Group description

collapseDescription - if the description should be collapsed

icon - Group icon

Returns:

the panel that allows adding more components to it

addVerticalGlue

public void addVerticalGlue()

Adds a component that acts as Box.verticalGlue()

removeLastRow

public void removeLastRow()

Removes the last row. Silently fails if there are no rows.

clear

public void clear()

Removes all components

getEntries

public List<JIPipeDesktopFormPanel.FormPanelEntry> getEntries()

addVerticalGlue

public void addVerticalGlue(Component component,
                            MarkdownText document)

Adds a vertical glue component

Parameters:

component - the component

document - optional documentation

installComponentHighlighter

public void installComponentHighlighter(JComponent triggerComponent,
                                        Set<Component> targetComponents)