T
- Class parameter that specifies the type of band control panel
implementation.ImageObserver
, MenuContainer
, Serializable
JFlowRibbonBand
, JRibbonBand
public abstract class AbstractRibbonBand<T extends AbstractBandControlPanel> extends JComponent
RibbonTask
. This is an abstract
base class for two types of ribbon bands - flow in JFlowRibbonBand
and general in JRibbonBand
.
This class provides the following common functionality:
RibbonBandResizePolicy
and CoreRibbonResizePolicies
) -
the band content is replaced by one collapsed button. When that button is
activated, the original ribbon band content is shown in a popup panel.Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Container.AccessibleAWTContainer
JComponent.AccessibleJComponent
Modifier and Type | Field | Description |
---|---|---|
protected T |
controlPanel |
Band control panel.
|
protected List<RibbonBandResizePolicy> |
resizePolicies |
The list of available resize policies.
|
static String |
uiClassID |
The UI class ID string.
|
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor | Description |
---|---|
AbstractRibbonBand(String title,
ResizableIcon icon,
ActionListener expandActionListener,
T controlPanel) |
Creates a new ribbon band.
|
Modifier and Type | Method | Description |
---|---|---|
abstract AbstractRibbonBand<T> |
cloneBand() |
Returns a clone of this ribbon band.
|
String |
getCollapsedStateKeyTip() |
Returns the key tip for the collapsed button which is shown when there is
not enough horizontal space to show the ribbon band content under the
most restrictive resize policy.
|
T |
getControlPanel() |
Returns the control panel of
this ribbon band. |
RibbonBandResizePolicy |
getCurrentResizePolicy() |
Returns the current resize policy of this ribbon band.
|
ActionListener |
getExpandActionListener() |
Returns the expand action listener of
this ribbon band. |
String |
getExpandButtonKeyTip() |
Returns the key tip for the expand button of this ribbon band.
|
RichTooltip |
getExpandButtonRichTooltip() |
Returns the rich tooltip for the expand button of this ribbon band.
|
ResizableIcon |
getIcon() |
Returns the icon for the collapsed state.
|
AbstractRibbonBand |
getPopupRibbonBand() |
Returns the ribbon band shown in a popup panel when this ribbon band is
in a collapsed state.
|
List<RibbonBandResizePolicy> |
getResizePolicies() |
Returns an unmodifiable list of available resize policies of this ribbon
band.
|
String |
getTitle() |
Returns the title of
this band. |
RibbonBandUI |
getUI() |
Returns the UI object which implements the L&F for this component.
|
String |
getUIClassID() |
|
void |
setCollapsedStateKeyTip(String collapsedStateKeyTip) |
Changes the key tip for the collapsed button which is shown when there is
not enough horizontal space to show the ribbon band content under the
most restrictive resize policy.
|
void |
setControlPanel(T controlPanel) |
Sets the control panel of
this ribbon band. |
void |
setCurrentResizePolicy(RibbonBandResizePolicy resizePolicy) |
Sets the specified parameter to be the current resize policy of this
ribbon band.
|
void |
setExpandActionListener(ActionListener expandActionListener) |
Sets the specified action listener to be activated when the user clicks
the expand button on this ribbon band.
|
void |
setExpandButtonKeyTip(String expandButtonKeyTip) |
Changes the key tip for the expand button of this ribbon band.
|
void |
setExpandButtonRichTooltip(RichTooltip expandButtonRichTooltip) |
Changes the rich tooltip for the expand button of this ribbon band.
|
void |
setIcon(ResizableIcon icon) |
Changes the icon for the collapsed state of this ribbon band.
|
void |
setPopupRibbonBand(AbstractRibbonBand popupRibbonBand) |
Sets the specified parameter to be the ribbon band shown in a popup panel
when this ribbon band is in a collapsed state.
|
void |
setResizePolicies(List<RibbonBandResizePolicy> resizePolicies) |
Sets the specified parameter as the available resize policies of this
ribbon band.
|
void |
setTitle(String title) |
Changes the title of this ribbon band.
|
void |
setUI(RibbonBandUI ui) |
Sets the new UI delegate.
|
void |
updateUI() |
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
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
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
public static final String uiClassID
protected T extends AbstractBandControlPanel controlPanel
popupRibbonBand
in a popup panel. The collapsed
button itself is implemented as a part of the UI delegate in
BasicRibbonBandUI
.popupRibbonBand
,
icon
protected List<RibbonBandResizePolicy> resizePolicies
public AbstractRibbonBand(String title, ResizableIcon icon, ActionListener expandActionListener, T controlPanel)
title
- Band title.icon
- Associated icon (for collapsed state).expandActionListener
- Expand action listener (can be null
).controlPanel
- The control panel of this ribbon band.public abstract AbstractRibbonBand<T> cloneBand()
public RibbonBandUI getUI()
getUI
in class JComponent
RibbonBandUI
objectsetUI(RibbonBandUI)
public void setUI(RibbonBandUI ui)
ui
- New UI delegate.public void updateUI()
updateUI
in class JComponent
public String getUIClassID()
getUIClassID
in class JComponent
public ResizableIcon getIcon()
AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
public void setIcon(ResizableIcon icon)
icon
property change event.icon
- The new icon for the collapsed state.AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
,
getIcon()
public String getTitle()
this
band.this
band.setTitle(String)
public void setTitle(String title)
title
property change event.title
- The new title for this ribbon band.AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
,
getTitle()
public ActionListener getExpandActionListener()
this
ribbon band. The
result may be null
.this
ribbon band.AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
,
setExpandActionListener(ActionListener)
public void setExpandActionListener(ActionListener expandActionListener)
null
will
remove the expand button from this ribbon band.expandActionListener
- Expand action listener for this ribbon band.getExpandActionListener()
public T getControlPanel()
this
ribbon band. The result
may be null
.this
ribbon band.AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
,
setControlPanel(AbstractBandControlPanel)
public void setControlPanel(T controlPanel)
this
ribbon band. The parameter
may be null
. This method is for internal use only.controlPanel
- The new control panel for this
ribbon band. May
be null
.AbstractRibbonBand(String, ResizableIcon, ActionListener,
AbstractBandControlPanel)
,
getControlPanel()
public AbstractRibbonBand getPopupRibbonBand()
setPopupRibbonBand(AbstractRibbonBand)
public void setPopupRibbonBand(AbstractRibbonBand popupRibbonBand)
popupRibbonBand
- The ribbon band to be shown in a popup panel when this ribbon
band is in a collapsed state.public RibbonBandResizePolicy getCurrentResizePolicy()
public void setCurrentResizePolicy(RibbonBandResizePolicy resizePolicy)
resizePolicy
- The new resize policy for this ribbon band.getCurrentResizePolicy()
,
getResizePolicies()
public List<RibbonBandResizePolicy> getResizePolicies()
public void setResizePolicies(List<RibbonBandResizePolicy> resizePolicies)
RibbonBandResizePolicy.getPreferredWidth(int, int)
. Each
successive entry in the list must return the value smaller than its
predecessors. If IconRibbonBandResizePolicy
is in the list, it
must be the last entry.resizePolicies
- The new available resize policies of this ribbon band.public String getExpandButtonKeyTip()
setExpandButtonKeyTip(String)
public void setExpandButtonKeyTip(String expandButtonKeyTip)
expandButtonKeyTip
property change event.expandButtonKeyTip
- The new key tip for the expand button of this ribbon band.getExpandButtonKeyTip()
public RichTooltip getExpandButtonRichTooltip()
setExpandButtonRichTooltip(RichTooltip)
public void setExpandButtonRichTooltip(RichTooltip expandButtonRichTooltip)
expandButtonRichTooltip
property change event.expandButtonRichTooltip
- The new rich tooltip for the expand button of this ribbon
band.getExpandButtonRichTooltip()
public String getCollapsedStateKeyTip()
setCollapsedStateKeyTip(String)
public void setCollapsedStateKeyTip(String collapsedStateKeyTip)
collapsedStateKeyTip
property change event.collapsedStateKeyTip
- The new key tip for the collapsed button of this ribbon band.getCollapsedStateKeyTip()