org.hkijena.jipipe.desktop.commons.components.ribbon

Class JIPipeDesktopRibbon

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.desktop.commons.components.ribbon.JIPipeDesktopRibbon

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JIPipeDesktopRibbon
extends JPanel

A simple Ribbon-style panel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDesktopRibbon.Action An action within the ribbon
static class	JIPipeDesktopRibbon.Band Secondary organization within one task Creates a label at the bottom of the current tak tab Separated from other bands via a separator line
static class	JIPipeDesktopRibbon.Task The highest-order organization of a ribbon.

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 Border	DEFAULT_BORDER

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
JIPipeDesktopRibbon(int numRows, JIPipeDesktopRibbon.Task... tasks)
JIPipeDesktopRibbon(JIPipeDesktopRibbon.Task... tasks)

Method Summary

Modifier and Type	Method and Description
JIPipeDesktopRibbon.Task	addTask(String label) Adds a new task.
JIPipeDesktopRibbon.Task	addTask(String id, String label) Adds a new task.
void	clear() Clears the ribbon.
int	getNumRows()
JIPipeDesktopRibbon.Task	getOrCreateTask(String id)
JIPipeDesktopRibbon.Task	getOrCreateTask(String id, String label)
String	getSelectedTask()
JIPipeDesktopTabPane	getTabPane()
List<JIPipeDesktopRibbon.Task>	getTasks()
static void	main(String[] args)
void	rebuildRibbon()
void	reorderTasks(List<String> ids) Reorders the tasks according to the list of IDs.
void	selectTask(String id)
void	setNumRows(int numRows) Sets the number of rows Will not rebuild the ribbon!
void	setTasks(List<JIPipeDesktopRibbon.Task> tasks)

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

DEFAULT_BORDER

public static final Border DEFAULT_BORDER

Constructor Detail

JIPipeDesktopRibbon

public JIPipeDesktopRibbon(JIPipeDesktopRibbon.Task... tasks)

JIPipeDesktopRibbon

public JIPipeDesktopRibbon(int numRows,
                           JIPipeDesktopRibbon.Task... tasks)

Method Detail

main

public static void main(String[] args)

rebuildRibbon

public void rebuildRibbon()

getTasks

public List<JIPipeDesktopRibbon.Task> getTasks()

setTasks

public void setTasks(List<JIPipeDesktopRibbon.Task> tasks)

getNumRows

public int getNumRows()

setNumRows

public void setNumRows(int numRows)

Sets the number of rows Will not rebuild the ribbon!

Parameters:

numRows - the number of rows

clear

public void clear()

Clears the ribbon. Will not rebuild the ribbon!

addTask

public JIPipeDesktopRibbon.Task addTask(String label)

Adds a new task. Will not rebuild the ribbon.

Parameters:

label - the label

Returns:

the task

addTask

public JIPipeDesktopRibbon.Task addTask(String id,
                                        String label)

Adds a new task. Will not rebuild the ribbon.

Parameters:

id - the ID

label - the label

Returns:

the task

getOrCreateTask

public JIPipeDesktopRibbon.Task getOrCreateTask(String id)

getOrCreateTask

public JIPipeDesktopRibbon.Task getOrCreateTask(String id,
                                                String label)

selectTask

public void selectTask(String id)

getSelectedTask

public String getSelectedTask()

getTabPane

public JIPipeDesktopTabPane getTabPane()

reorderTasks

public void reorderTasks(List<String> ids)

Reorders the tasks according to the list of IDs. If there are tasks outside the ID list, their order will be preserved Will not rebuild the ribbon.

Parameters:

ids - the IDs