org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonTaskToggleButton

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable

public class JRibbonTaskToggleButton extends JCommandToggleButton

Toggle button for ribbon tasks. This class is for internal use only and should not be directly used by the applications.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton
AbstractCommandButton.CommandButtonLocationOrderKind

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

Description

static final String

uiClassID

The UI class ID string.

Fields inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton
actionHandler, actionKeyTip, actionModel, customDimension, disabledIcon, displayState, extraText, icon, isFlat

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

Description

JRibbonTaskToggleButton(RibbonTask ribbonTask)

Creates a new toggle button.
Method Summary

Modifier and Type

Method

Description

Color

getContextualGroupHueColor()

Returns the hue color of the matching contextual task group if the associated task is contextual.

String

getKeyTip()

RibbonTask

getRibbonTask()

String

getUIClassID()

void

setContextualGroupHueColor(Color contextualGroupHueColor)

Sets the hue color of the matching contextual task group on this button.

void

setKeyTip(String keyTip)

void

updateUI()

Resets the UI property to a value from the current look and feel.

Methods inherited from class org.pushingpixels.flamingo.api.common.JCommandToggleButton
toString

Methods inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton
addActionListener, addChangeListener, doActionClick, fireActionPerformed, fireStateChanged, getActionKeyTip, getActionModel, getCustomDimension, getDisabledIcon, getDisplayState, getExtraText, getHGapScaleFactor, getHorizontalAlignment, getIcon, getLocationOrderKind, getRichTooltip, getText, getUI, getVGapScaleFactor, isFlat, removeActionListener, removeChangeListener, setActionKeyTip, setActionModel, setActionRichTooltip, setDisabledIcon, setDisplayState, setEnabled, setExtraText, setFlat, setGapScaleFactor, setHGapScaleFactor, setHorizontalAlignment, setIcon, setLocationOrderKind, setText, setToolTipText, setUI, setVGapScaleFactor, updateCustomDimension

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, paramString, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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, getAccessibleContext, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- uiClassID
  
  public static final String uiClassID
  
  The UI class ID string.
  See Also:
  
  Constant Field Values
Constructor Details
- JRibbonTaskToggleButton
  
  public JRibbonTaskToggleButton(RibbonTask ribbonTask)
  
  Creates a new toggle button.
  
  Parameters:
  
  ribbonTask -
Method Details
- updateUI
  
  public void updateUI()
  
  Description copied from class: JCommandToggleButton
  
  Resets the UI property to a value from the current look and feel.
  Overrides:
  
  updateUI in class JCommandToggleButton
  
  See Also:
  
  JComponent.updateUI()
- getUIClassID
  
  public String getUIClassID()
  
  Overrides:
  
  getUIClassID in class JCommandToggleButton
- getContextualGroupHueColor
  
  public Color getContextualGroupHueColor()
  
  Returns the hue color of the matching contextual task group if the associated task is contextual.
  
  Returns:
  
  The hue color of the matching contextual task group if the associated task is contextual, null otherwise.
- getRibbonTask
  
  public RibbonTask getRibbonTask()
- setContextualGroupHueColor
  
  public void setContextualGroupHueColor(Color contextualGroupHueColor)
  
  Sets the hue color of the matching contextual task group on this button.
  
  Parameters:
  
  contextualGroupHueColor - The hue color of the matching contextual task group.
- setKeyTip
  
  public void setKeyTip(String keyTip)
- getKeyTip
  
  public String getKeyTip()

Class JRibbonTaskToggleButton

Nested Class Summary

Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class org.pushingpixels.flamingo.api.common.JCommandToggleButton

Methods inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Details

uiClassID

Constructor Details

JRibbonTaskToggleButton

Method Details

updateUI

getUIClassID

getContextualGroupHueColor

getRibbonTask

setContextualGroupHueColor

setKeyTip

getKeyTip