Class CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy
java.lang.Object
org.pushingpixels.radiance.component.api.ribbon.resize.CoreRibbonResizePolicies.BaseRibbonBandResizePolicy<JRibbonBand>
org.pushingpixels.radiance.component.api.ribbon.resize.CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy
- All Implemented Interfaces:
RibbonBandResizePolicy
- Direct Known Subclasses:
CoreRibbonResizePolicies.High2Low
,CoreRibbonResizePolicies.High2Mid
,CoreRibbonResizePolicies.Low2Mid
,CoreRibbonResizePolicies.Mid2Low
,CoreRibbonResizePolicies.Mid2Mid
,CoreRibbonResizePolicies.Mirror
,CoreRibbonResizePolicies.None
- Enclosing class:
CoreRibbonResizePolicies
public abstract static class CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy
extends CoreRibbonResizePolicies.BaseRibbonBandResizePolicy<JRibbonBand>
The base class for mapping-based core resize policies.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CoreRibbonResizePolicies.Mapping
The element priority mapping.Fields inherited from class org.pushingpixels.radiance.component.api.ribbon.resize.CoreRibbonResizePolicies.BaseRibbonBandResizePolicy
controlPanel, ribbonBand
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BaseCoreRibbonBandResizePolicy
(JRibbonBand ribbonBand, CoreRibbonResizePolicies.Mapping mapping) Creates a new resize policy. -
Method Summary
Modifier and TypeMethodDescriptionprotected int
getPreferredButtonWidth
(JBandControlPanel.ControlPanelGroup controlPanelGroup, int gap) Returns the preferred width of all the buttons in the specified control panel group.private int
getPreferredGalleryWidth
(JBandControlPanel.ControlPanelGroup controlPanelGroup, int galleryAvailableHeight, int gap) Returns the preferred width of all the ribbon galleries in the specified control panel group.int
getPreferredWidth
(int availableHeight, int gap) Returns the preferred width of the associated ribbon band under the specified dimensions.private int
getPreferredWidth
(JCommandButton button, JRibbonBand.PresentationPriority buttonPresentationPriority) Returns the preferred width of the specified command button under the specified presentation priority.protected int
getWidth
(int gap, List<JCommandButton> bigButtons, List<JCommandButton> mediumButtons, List<JCommandButton> smallButtons) Returns the total width of the specified buttons.void
install
(int availableHeight, int gap) Installs this resize policy on the associated ribbon band.
-
Field Details
-
mapping
The element priority mapping.
-
-
Constructor Details
-
BaseCoreRibbonBandResizePolicy
protected BaseCoreRibbonBandResizePolicy(JRibbonBand ribbonBand, CoreRibbonResizePolicies.Mapping mapping) Creates a new resize policy.- Parameters:
ribbonBand
- The associated ribbon band.mapping
- The element priority mapping.
-
-
Method Details
-
getWidth
protected int getWidth(int gap, List<JCommandButton> bigButtons, List<JCommandButton> mediumButtons, List<JCommandButton> smallButtons) Returns the total width of the specified buttons.- Parameters:
gap
- Inter component gap.bigButtons
- List of buttons in big presentation state.mediumButtons
- List of buttons in medium presentation state.smallButtons
- List of buttons in small presentation state.- Returns:
- Total width of the specified buttons.
-
getPreferredWidth
private int getPreferredWidth(JCommandButton button, JRibbonBand.PresentationPriority buttonPresentationPriority) Returns the preferred width of the specified command button under the specified presentation priority.- Parameters:
button
- Command button.buttonPresentationPriority
- Button presentation priority.- Returns:
- The preferred width of the specified command button under the specified presentation priority.
-
getPreferredWidth
public int getPreferredWidth(int availableHeight, int gap) Description copied from interface:RibbonBandResizePolicy
Returns the preferred width of the associated ribbon band under the specified dimensions.- Parameters:
availableHeight
- The height available for the associated ribbon band.gap
- The inter-component gap.- Returns:
- The preferred width of the associated ribbon band under the specified dimensions.
-
getPreferredButtonWidth
protected int getPreferredButtonWidth(JBandControlPanel.ControlPanelGroup controlPanelGroup, int gap) Returns the preferred width of all the buttons in the specified control panel group.- Parameters:
controlPanelGroup
- A single control panel group in the associated ribbon band.gap
- Inter component gap.- Returns:
- The preferred width of all the buttons in the specified control panel group.
-
getPreferredGalleryWidth
private int getPreferredGalleryWidth(JBandControlPanel.ControlPanelGroup controlPanelGroup, int galleryAvailableHeight, int gap) Returns the preferred width of all the ribbon galleries in the specified control panel group.- Parameters:
controlPanelGroup
- A single control panel group in the associated ribbon band.galleryAvailableHeight
- Available height for the ribbon galleries.gap
- Inter component gap.- Returns:
- The preferred width of all the ribbon galleries in the specified control panel group.
-
install
public void install(int availableHeight, int gap) Description copied from interface:RibbonBandResizePolicy
Installs this resize policy on the associated ribbon band. ForJFlowRibbonBand
s only changes the bounds of the flow components. ForJRibbonBand
s can also change the presentation state of the command buttons (withJCommandButton.setPresentationState(CommandButtonPresentationState)
) and the number of visible buttons in the ribbon galleries. Note that this method is for internal use only and should not be called by the application code.- Parameters:
availableHeight
- The height available for the associated ribbon band.gap
- The inter-component gap.
-