org.hkijena.jipipe.ui.parameters

Class ParameterPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jdesktop.swingx.JXPanel

org.hkijena.jipipe.ui.components.FormPanel

org.hkijena.jipipe.ui.parameters.ParameterPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, Contextual

public class ParameterPanel
extends FormPanel
implements Contextual

UI around a JIPipeParameterCollection

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.ui.components.FormPanel

FormPanel.FormPanelContentPanel, FormPanel.FormPanelEntry, FormPanel.GroupHeaderPanel, FormPanel.HoverHelpEvent

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	DEFAULT_DIALOG_FLAGS Flags suitable for standalone dialogs
static int	FORCE_TRAVERSE With this flag, the parameter collection is always traversed, even if the provided parameter collection was already traversed
static int	NO_EMPTY_GROUP_HEADERS Flag for ParameterPanel.
static int	NO_GROUP_HEADERS Flag for ParameterPanel.
static int	WITH_SEARCH_BAR With this flag, there will be a search bar for parameters.
static int	WITHOUT_COLLAPSE With this flag, collapsing is disabled
static int	WITHOUT_LABEL_SEPARATION With this flag, parameters that do not show a label are not put below anymore

Fields inherited from class org.hkijena.jipipe.ui.components.FormPanel

DOCUMENTATION_BELOW, DOCUMENTATION_NO_UI, NONE, WITH_DOCUMENTATION, 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
ParameterPanel(JIPipeWorkbench workbench, JIPipeParameterCollection displayedParameters, MarkdownDocument documentation, int flags)

Method Summary

Modifier and Type	Method and Description
Context	context()
protected Component	createEntryPropertiesComponent(Component component, Component description, int row, MarkdownDocument documentation)
static MarkdownDocument	generateParameterDocumentation(JIPipeParameterAccess access, JIPipeParameterTree tree)
Context	getContext()
BiFunction<JIPipeParameterTree,JIPipeParameterCollection,Boolean>	getCustomIsParameterCollectionVisible()
BiFunction<JIPipeParameterTree,JIPipeParameterAccess,Boolean>	getCustomIsParameterVisible()
JIPipeParameterCollection	getDisplayedParameters()
void	onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event) Triggered when the parameter structure was changed
void	onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event) Triggered when the parameter UI should be updated
void	refreshForm() Recreates the UI elements.
void	reloadForm() Reloads the form.
void	setContext(Context context)
void	setCustomIsParameterCollectionVisible(BiFunction<JIPipeParameterTree,JIPipeParameterCollection,Boolean> customIsParameterCollectionVisible)
void	setCustomIsParameterVisible(BiFunction<JIPipeParameterTree,JIPipeParameterAccess,Boolean> customIsParameterVisible)
void	setDisplayedParameters(JIPipeParameterCollection displayedParameters)
static boolean	showDialog(JIPipeWorkbench workbench, Component parent, JIPipeParameterCollection parameterCollection, MarkdownDocument defaultDocumentation, String title, int flags) Shows a parameter collection inside a modal dialog
static boolean	showDialog(JIPipeWorkbench workbench, JIPipeParameterCollection parameterCollection, MarkdownDocument defaultDocumentation, String title, int flags) Shows a parameter collection inside a modal dialog

Methods inherited from class org.hkijena.jipipe.ui.components.FormPanel

addGroupHeader, addToForm, addToForm, addVerticalGlue, addVerticalGlue, addWideToForm, addWideToForm, clear, getContentPanel, getEntries, getEventBus, getNumRows, getParameterHelp, getRedirectDocumentationTarget, getScrollPane, installComponentHighlighter, isHasVerticalGlue, isWithDocumentation, removeLastRow, setOpaque, setRedirectDocumentationTarget, showDocumentation, updateParameterHelpDrillDown

Methods inherited from class org.jdesktop.swingx.JXPanel

getAlpha, getBackgroundPainter, getEffectiveAlpha, getPainterChangeListener, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableHeightHint, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollableWidthHint, isInheritAlpha, isPaintBorderInsets, paint, paintComponent, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableHeightHint, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth, setScrollableWidthHint

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, paintBorder, paintChildren, 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, 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

NO_GROUP_HEADERS

public static final int NO_GROUP_HEADERS

Flag for ParameterPanel. Makes that no group headers are created. This includes dynamic parameter group headers that contain buttons for modification.

See Also:

Constant Field Values

NO_EMPTY_GROUP_HEADERS

public static final int NO_EMPTY_GROUP_HEADERS

Flag for ParameterPanel. Makes that group headers without name or description or special functionality (like dynamic parameters) are not shown. Overridden by NO_GROUP_HEADERS.

See Also:

Constant Field Values

FORCE_TRAVERSE

public static final int FORCE_TRAVERSE

With this flag, the parameter collection is always traversed, even if the provided parameter collection was already traversed

See Also:

Constant Field Values

WITH_SEARCH_BAR

public static final int WITH_SEARCH_BAR

With this flag, there will be a search bar for parameters. GeneralUISettings.isShowParameterSearchBar() will override this setting

See Also:

Constant Field Values

WITHOUT_LABEL_SEPARATION

public static final int WITHOUT_LABEL_SEPARATION

With this flag, parameters that do not show a label are not put below anymore

See Also:

Constant Field Values

WITHOUT_COLLAPSE

public static final int WITHOUT_COLLAPSE

With this flag, collapsing is disabled

See Also:

Constant Field Values

DEFAULT_DIALOG_FLAGS

public static final int DEFAULT_DIALOG_FLAGS

Flags suitable for standalone dialogs

See Also:

Constant Field Values

Constructor Detail

ParameterPanel

public ParameterPanel(JIPipeWorkbench workbench,
                      JIPipeParameterCollection displayedParameters,
                      MarkdownDocument documentation,
                      int flags)

Parameters:

workbench - SciJava context

displayedParameters - Object containing the parameters. If the object is an JIPipeParameterTree and FORCE_TRAVERSE is not set, it will be used directly. Can be null.

documentation - Optional documentation

flags - Flags

Method Detail

showDialog

public static boolean showDialog(JIPipeWorkbench workbench,
                                 JIPipeParameterCollection parameterCollection,
                                 MarkdownDocument defaultDocumentation,
                                 String title,
                                 int flags)

Shows a parameter collection inside a modal dialog

Parameters:

workbench - parent component

parameterCollection - the parameter collection

flags - flags for the editor

Returns:

if the user clicked "OK"

showDialog

public static boolean showDialog(JIPipeWorkbench workbench,
                                 Component parent,
                                 JIPipeParameterCollection parameterCollection,
                                 MarkdownDocument defaultDocumentation,
                                 String title,
                                 int flags)

Shows a parameter collection inside a modal dialog

Parameters:

workbench - parent component

parameterCollection - the parameter collection

flags - flags for the editor

Returns:

if the user clicked "OK"

generateParameterDocumentation

public static MarkdownDocument generateParameterDocumentation(JIPipeParameterAccess access,
                                                              JIPipeParameterTree tree)

getCustomIsParameterVisible

public BiFunction<JIPipeParameterTree,JIPipeParameterAccess,Boolean> getCustomIsParameterVisible()

setCustomIsParameterVisible

public void setCustomIsParameterVisible(BiFunction<JIPipeParameterTree,JIPipeParameterAccess,Boolean> customIsParameterVisible)

getCustomIsParameterCollectionVisible

public BiFunction<JIPipeParameterTree,JIPipeParameterCollection,Boolean> getCustomIsParameterCollectionVisible()

setCustomIsParameterCollectionVisible

public void setCustomIsParameterCollectionVisible(BiFunction<JIPipeParameterTree,JIPipeParameterCollection,Boolean> customIsParameterCollectionVisible)

reloadForm

public void reloadForm()

Reloads the form. This re-traverses the parameters and recreates the UI elements

refreshForm

public void refreshForm()

Recreates the UI elements. Does not re-traverse the parameters, meaning that the parameter structure is not updated

createEntryPropertiesComponent

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

Overrides:

createEntryPropertiesComponent in class FormPanel

onParameterStructureChanged

public void onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)

Triggered when the parameter structure was changed

Parameters:

event - generated event

onParameterUIChanged

public void onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event)

Triggered when the parameter UI should be updated

Parameters:

event - generated event

getDisplayedParameters

public JIPipeParameterCollection getDisplayedParameters()

Returns:

The parameterized object

setDisplayedParameters

public void setDisplayedParameters(JIPipeParameterCollection displayedParameters)

getContext

public Context getContext()

Specified by:

getContext in interface Contextual

setContext

public void setContext(Context context)

Specified by:

setContext in interface Contextual

context

public Context context()

Specified by:

context in interface Contextual