Package org.pushingpixels.radiance.component.internal.ui.ribbon

Class JRibbonComponent

    • Nested Class Summary

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

        javax.swing.JComponent.AccessibleJComponent

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

        java.awt.Container.AccessibleAWTContainer

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

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String caption
      Wrapper caption.
      private HorizontalAlignment horizontalAlignment
      The horizontal alignment for this wrapper component.
      private RadianceIcon icon
      Wrapper icon.
      private boolean isResizingAware  
      private java.lang.String keyTip
      The key tip for this wrapper component.
      private javax.swing.JComponent mainComponent
      The wrapped component.
      private JRibbonBand.PresentationPriority presentationPriority  
      private ComponentProjection<? extends javax.swing.JComponent,​? extends ComponentContentModel> projection  
      static java.lang.String uiClassID
      The UI class ID string.

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCaption()
      Returns the caption of this wrapper component.
      java.util.List<javax.swing.JComponent> getFocusSequence()  
      HorizontalAlignment getHorizontalAlignment()
      Returns the horizontal alignment for this wrapper component.
      RadianceIcon getIcon()
      Returns the wrapper icon of this wrapper component.
      java.lang.String getKeyTip()
      Returns the key tip for this wrapper component.
      javax.swing.JComponent getMainComponent()
      Returns the wrapped component of this wrapper component.
      JRibbonBand.PresentationPriority getPresentationPriority()  
      ComponentProjection<? extends javax.swing.JComponent,​? extends ComponentContentModel> getProjection()  
      RichTooltip getRichTooltip​(java.awt.event.MouseEvent mouseEvent)  
      RichTooltipPresentationModel getRichTooltipPresentationModel​(java.awt.event.MouseEvent mouseEvent)  
      RibbonComponentUI getUI()
      Returns the UI delegate for this component.
      java.lang.String getUIClassID()  
      boolean isResizingAware()  
      boolean isSimpleWrapper()
      Returns indication whether this wrapper is simple.
      void setCaption​(java.lang.String caption)
      Sets new value for the caption of this wrapper component.
      void setHorizontalAlignment​(HorizontalAlignment horizontalAlignment)
      Sets the specified parameter to be the horizontal alignment for this wrapper component.
      void setIcon​(RadianceIcon icon)  
      void setKeyTip​(java.lang.String keyTip)
      Sets the specified string to be the key tip for this wrapper component.
      void setPresentationPriority​(JRibbonBand.PresentationPriority presentationPriority)  
      void setResizingAware​(boolean isResizingAware)  
      void 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, 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, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • updateUI

        public void updateUI()
        Overrides:
        updateUI in class javax.swing.JComponent

      • getUIClassID

        public java.lang.String getUIClassID()
        Overrides:
        getUIClassID in class javax.swing.JComponent

      • getUI

        public RibbonComponentUI getUI()
        Returns the UI delegate for this component.
        Overrides:
        getUI in class javax.swing.JComponent
        Returns:
        a RibbonComponentUI object
        See Also:
        JComponent.setUI(javax.swing.plaf.ComponentUI)

      • getIcon

        public RadianceIcon getIcon()
        Returns the wrapper icon of this wrapper component. Can return null.
        Returns:
        The wrapper icon of this wrapper component.

      • getCaption

        public java.lang.String getCaption()
        Returns the caption of this wrapper component. Can return null.
        Returns:
        The caption of this wrapper component.

      • setCaption

        public void setCaption​(java.lang.String caption)
        Sets new value for the caption of this wrapper component.
        Parameters:
        caption - The new caption.

      • getMainComponent

        public javax.swing.JComponent getMainComponent()
        Returns the wrapped component of this wrapper component. The result is guaranteed to be non null.
        Returns:
        The wrapped component of this wrapper component.

      • isSimpleWrapper

        public boolean isSimpleWrapper()
        Returns indication whether this wrapper is simple.
        Returns:
        true if both getIcon() and getCaption() return null, false otherwise.

      • getKeyTip

        public java.lang.String getKeyTip()
        Returns the key tip for this wrapper component.
        Returns:
        The key tip for this wrapper component.
        See Also:
        setKeyTip(String)

      • setKeyTip

        public void setKeyTip​(java.lang.String keyTip)
        Sets the specified string to be the key tip for this wrapper component. Fires a keyTip property change event.
        Parameters:
        keyTip - The new key tip for this wrapper component.

      • setHorizontalAlignment

        public void setHorizontalAlignment​(HorizontalAlignment horizontalAlignment)
        Sets the specified parameter to be the horizontal alignment for this wrapper component.
        Parameters:
        horizontalAlignment - The new horizontal alignment for this wrapper component.
        See Also:
        getHorizontalAlignment()

      • isResizingAware

        public boolean isResizingAware()

      • setResizingAware

        public void setResizingAware​(boolean isResizingAware)

      • getFocusSequence

        public java.util.List<javax.swing.JComponent> getFocusSequence()
        Specified by:
        getFocusSequence in interface JExoContainer