org.hkijena.jipipe.utils.ui

Class JIPipeDesktopDockPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.utils.ui.JIPipeDesktopDockPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JIPipeDesktopSplitPane.RatioUpdatedEventListener

public class JIPipeDesktopDockPanel
extends JPanel
implements JIPipeDesktopSplitPane.RatioUpdatedEventListener

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDesktopDockPanel.Panel
static class	JIPipeDesktopDockPanel.PanelLocation
static class	JIPipeDesktopDockPanel.PanelSide
static class	JIPipeDesktopDockPanel.PanelSideVisibilityChangedEvent
static class	JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventEmitter
static interface	JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventListener
static class	JIPipeDesktopDockPanel.State
static class	JIPipeDesktopDockPanel.StateSavedEvent
static class	JIPipeDesktopDockPanel.StateSavedEventEmitter
static interface	JIPipeDesktopDockPanel.StateSavedEventListener

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	UI_ORDER_DEFAULT
static int	UI_ORDER_PINNED

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
JIPipeDesktopDockPanel()

Method Summary

Modifier and Type	Method and Description
void	activatePanel(String id, boolean saveState)
void	addDockPanel(String id, String name, Icon icon, JIPipeDesktopDockPanel.PanelLocation location, boolean visible, int uiOrder, JComponent component)
void	addDockPanel(String id, String name, Icon icon, JIPipeDesktopDockPanel.PanelLocation location, boolean visible, int uiOrder, Supplier<JComponent> component)
boolean	containsPanel(String id)
void	deactivatePanel(JIPipeDesktopDockPanel.Panel panel, boolean saveState)
void	deactivatePanels(JIPipeDesktopDockPanel.PanelLocation location, boolean saveState) Deactivates all panels at a given location
String	getCurrentlyVisiblePanelId(JIPipeDesktopDockPanel.PanelLocation location, boolean withHidden)
JIPipeDesktopDockPanel.State	getCurrentState()
int	getFloatingPanelMarginBottom()
int	getFloatingPanelMarginLeftRight()
int	getFloatingPanelMarginTop()
int	getLeftPanelWidth()
int	getMinimumBackgroundWidth()
int	getMinimumPanelWidth()
<T extends JComponent> T	getPanelComponent(String id, Class<T> klass)
Map<String,JIPipeDesktopDockPanel.Panel>	getPanels()
List<JIPipeDesktopDockPanel.Panel>	getPanelsAtLocation(JIPipeDesktopDockPanel.PanelLocation location)
JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventEmitter	getPanelSideVisibilityChangedEventEmitter()
JIPipeParameterCollection.ParameterChangedEventEmitter	getParameterChangedEventEmitter()
int	getRightPanelWidth()
JIPipeDesktopDockPanel.State	getSavedState()
JIPipeDesktopDockPanel.StateSavedEventEmitter	getStateSavedEventEmitter()
int	getToolbarWithLabelsWidth()
int	getToolbarWithoutLabelsWidth()
boolean	isHideToolbars()
boolean	isLeftPanelIsFloating()
boolean	isLeftPanelVisible()
boolean	isRightPanelIsFloating()
boolean	isRightPanelVisible()
boolean	isShowToolbarLabels()
void	movePanelToLocation(String id, JIPipeDesktopDockPanel.PanelLocation newLocation, boolean saveState)
void	onSplitPaneRatioUpdated(JIPipeDesktopSplitPane.RatioUpdatedEvent event)
void	removeAllPanels()
void	removeDockPanel(String id)
void	removeDockPanelsIf(Predicate<JIPipeDesktopDockPanel.Panel> predicate)
void	restoreState(JIPipeDesktopDockPanel.State state)
void	setBackgroundComponent(JComponent component)
void	setFloatingPanelMarginBottom(int floatingPanelMarginBottom)
void	setFloatingPanelMarginLeftRight(int floatingPanelMarginLeftRight)
void	setFloatingPanelMarginTop(int floatingPanelMarginTop)
void	setHideToolbars(boolean hideToolbars)
void	setLeftPanelIsFloating(boolean leftPanelIsFloating)
void	setLeftPanelWidth(int leftPanelWidth)
void	setMinimumBackgroundWidth(int minimumBackgroundWidth)
void	setMinimumPanelWidth(int minimumPanelWidth)
void	setRightPanelIsFloating(boolean rightPanelIsFloating)
void	setRightPanelWidth(int rightPanelWidth)
void	setSavedState(JIPipeDesktopDockPanel.State savedState)
void	setShowToolbarLabels(boolean showToolbarLabels)
void	setToolbarWithLabelsWidth(int toolbarWithLabelsWidth)
void	setToolbarWithoutLabelsWidth(int toolbarWithoutLabelsWidth)
void	updateSizes()

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

UI_ORDER_PINNED

public static final int UI_ORDER_PINNED

See Also:

Constant Field Values

UI_ORDER_DEFAULT

public static final int UI_ORDER_DEFAULT

See Also:

Constant Field Values

Constructor Detail

JIPipeDesktopDockPanel

public JIPipeDesktopDockPanel()

Method Detail

setBackgroundComponent

public void setBackgroundComponent(JComponent component)

isShowToolbarLabels

public boolean isShowToolbarLabels()

setShowToolbarLabels

public void setShowToolbarLabels(boolean showToolbarLabels)

getParameterChangedEventEmitter

public JIPipeParameterCollection.ParameterChangedEventEmitter getParameterChangedEventEmitter()

getToolbarWithLabelsWidth

public int getToolbarWithLabelsWidth()

setToolbarWithLabelsWidth

public void setToolbarWithLabelsWidth(int toolbarWithLabelsWidth)

getToolbarWithoutLabelsWidth

public int getToolbarWithoutLabelsWidth()

setToolbarWithoutLabelsWidth

public void setToolbarWithoutLabelsWidth(int toolbarWithoutLabelsWidth)

updateSizes

public void updateSizes()

deactivatePanel

public void deactivatePanel(JIPipeDesktopDockPanel.Panel panel,
                            boolean saveState)

isLeftPanelIsFloating

public boolean isLeftPanelIsFloating()

setLeftPanelIsFloating

public void setLeftPanelIsFloating(boolean leftPanelIsFloating)

isRightPanelIsFloating

public boolean isRightPanelIsFloating()

setRightPanelIsFloating

public void setRightPanelIsFloating(boolean rightPanelIsFloating)

getPanelsAtLocation

public List<JIPipeDesktopDockPanel.Panel> getPanelsAtLocation(JIPipeDesktopDockPanel.PanelLocation location)

movePanelToLocation

public void movePanelToLocation(String id,
                                JIPipeDesktopDockPanel.PanelLocation newLocation,
                                boolean saveState)

deactivatePanels

public void deactivatePanels(JIPipeDesktopDockPanel.PanelLocation location,
                             boolean saveState)

Deactivates all panels at a given location

Parameters:

location - the location

saveState - save the state

getCurrentlyVisiblePanelId

public String getCurrentlyVisiblePanelId(JIPipeDesktopDockPanel.PanelLocation location,
                                         boolean withHidden)

removeDockPanel

public void removeDockPanel(String id)

addDockPanel

public void addDockPanel(String id,
                         String name,
                         Icon icon,
                         JIPipeDesktopDockPanel.PanelLocation location,
                         boolean visible,
                         int uiOrder,
                         JComponent component)

addDockPanel

public void addDockPanel(String id,
                         String name,
                         Icon icon,
                         JIPipeDesktopDockPanel.PanelLocation location,
                         boolean visible,
                         int uiOrder,
                         Supplier<JComponent> component)

getSavedState

public JIPipeDesktopDockPanel.State getSavedState()

setSavedState

public void setSavedState(JIPipeDesktopDockPanel.State savedState)

restoreState

public void restoreState(JIPipeDesktopDockPanel.State state)

isLeftPanelVisible

public boolean isLeftPanelVisible()

isRightPanelVisible

public boolean isRightPanelVisible()

activatePanel

public void activatePanel(String id,
                          boolean saveState)

getPanelComponent

public <T extends JComponent> T getPanelComponent(String id,
                                                  Class<T> klass)

getStateSavedEventEmitter

public JIPipeDesktopDockPanel.StateSavedEventEmitter getStateSavedEventEmitter()

onSplitPaneRatioUpdated

public void onSplitPaneRatioUpdated(JIPipeDesktopSplitPane.RatioUpdatedEvent event)

Specified by:

onSplitPaneRatioUpdated in interface JIPipeDesktopSplitPane.RatioUpdatedEventListener

getPanelSideVisibilityChangedEventEmitter

public JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventEmitter getPanelSideVisibilityChangedEventEmitter()

getLeftPanelWidth

public int getLeftPanelWidth()

setLeftPanelWidth

public void setLeftPanelWidth(int leftPanelWidth)

getRightPanelWidth

public int getRightPanelWidth()

setRightPanelWidth

public void setRightPanelWidth(int rightPanelWidth)

getMinimumPanelWidth

public int getMinimumPanelWidth()

setMinimumPanelWidth

public void setMinimumPanelWidth(int minimumPanelWidth)

getFloatingPanelMarginTop

public int getFloatingPanelMarginTop()

setFloatingPanelMarginTop

public void setFloatingPanelMarginTop(int floatingPanelMarginTop)

getMinimumBackgroundWidth

public int getMinimumBackgroundWidth()

setMinimumBackgroundWidth

public void setMinimumBackgroundWidth(int minimumBackgroundWidth)

getFloatingPanelMarginBottom

public int getFloatingPanelMarginBottom()

setFloatingPanelMarginBottom

public void setFloatingPanelMarginBottom(int floatingPanelMarginBottom)

getFloatingPanelMarginLeftRight

public int getFloatingPanelMarginLeftRight()

setFloatingPanelMarginLeftRight

public void setFloatingPanelMarginLeftRight(int floatingPanelMarginLeftRight)

removeDockPanelsIf

public void removeDockPanelsIf(Predicate<JIPipeDesktopDockPanel.Panel> predicate)

getCurrentState

public JIPipeDesktopDockPanel.State getCurrentState()

removeAllPanels

public void removeAllPanels()

containsPanel

public boolean containsPanel(String id)

getPanels

public Map<String,JIPipeDesktopDockPanel.Panel> getPanels()

isHideToolbars

public boolean isHideToolbars()

setHideToolbars

public void setHideToolbars(boolean hideToolbars)