public class JRibbonComponent extends RichToolTipManager.JTrackableComponent
JRibbonBand
.javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
uiClassID
The UI class ID string.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
JRibbonComponent(javax.swing.JComponent mainComponent)
Creates a simple wrapper with no icon and no caption.
|
JRibbonComponent(ResizableIcon icon,
java.lang.String caption,
javax.swing.JComponent mainComponent)
Creates a wrapper with an icon and a caption.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaption()
Returns the caption of this wrapper component.
|
RibbonElementPriority |
getDisplayPriority() |
HorizontalAlignment |
getHorizontalAlignment()
Returns the horizontal alignment for this wrapper component.
|
ResizableIcon |
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.
|
RichTooltip |
getRichTooltip(java.awt.event.MouseEvent mouseEvent) |
RibbonComponentUI |
getUI()
Returns the UI object which implements the L&F 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 |
setDisplayPriority(RibbonElementPriority displayPriority) |
void |
setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
Sets the specified parameter to be the horizontal alignment for this
wrapper component.
|
void |
setKeyTip(java.lang.String keyTip)
Sets the specified string to be the key tip for this wrapper component.
|
void |
setResizingAware(boolean isResizingAware) |
void |
setRichTooltip(RichTooltip richTooltip)
Sets the rich tooltip for this wrapper component.
|
void |
updateUI() |
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
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
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, 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
public static final java.lang.String uiClassID
public JRibbonComponent(javax.swing.JComponent mainComponent)
mainComponent
- Wrapped component. Can not be null
.java.lang.IllegalArgumentException
- if mainComponent
is null
.public JRibbonComponent(ResizableIcon icon, java.lang.String caption, javax.swing.JComponent mainComponent)
icon
- Wrapper icon. Can be null
.caption
- Wrapper caption. Can not be null
.mainComponent
- Wrapped component. Can not be null
.java.lang.IllegalArgumentException
- if caption
or mainComponent
is
null
.public void updateUI()
updateUI
in class javax.swing.JComponent
public java.lang.String getUIClassID()
getUIClassID
in class javax.swing.JComponent
public RibbonComponentUI getUI()
RibbonUI
objectJComponent.setUI(javax.swing.plaf.ComponentUI)
public ResizableIcon getIcon()
null
.JRibbonComponent(ResizableIcon, String, JComponent)
public java.lang.String getCaption()
null
.JRibbonComponent(ResizableIcon, String, JComponent)
public void setCaption(java.lang.String caption)
caption
- The new caption.public javax.swing.JComponent getMainComponent()
null
.public boolean isSimpleWrapper()
true
if both getIcon()
and
getCaption()
return null
,
false
otherwise.public java.lang.String getKeyTip()
setKeyTip(String)
public void setKeyTip(java.lang.String keyTip)
keyTip
property change event.keyTip
- The new key tip for this wrapper component.public RichTooltip getRichTooltip(java.awt.event.MouseEvent mouseEvent)
getRichTooltip
in class RichToolTipManager.JTrackableComponent
public void setRichTooltip(RichTooltip richTooltip)
richTooltip
- getRichTooltip(MouseEvent)
public HorizontalAlignment getHorizontalAlignment()
setHorizontalAlignment(HorizontalAlignment)
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
horizontalAlignment
- The new horizontal alignment for this wrapper component.getHorizontalAlignment()
public RibbonElementPriority getDisplayPriority()
public void setDisplayPriority(RibbonElementPriority displayPriority)
public boolean isResizingAware()
public void setResizingAware(boolean isResizingAware)