Class IconRibbonBandResizePolicy
- java.lang.Object
-
- org.pushingpixels.flamingo.api.ribbon.resize.BaseRibbonBandResizePolicy<AbstractBandControlPanel>
-
- org.pushingpixels.flamingo.api.ribbon.resize.IconRibbonBandResizePolicy
-
- All Implemented Interfaces:
RibbonBandResizePolicy
public class IconRibbonBandResizePolicy extends BaseRibbonBandResizePolicy<AbstractBandControlPanel>
Special resize policy that is used for collapsed ribbon bands. When there is not enough horizontal space to show the ribbon band content under the most restructiveRibbonBandResizePolicy
, the entire ribbon band content is replaced by a single popup button. Activating the popup button will show the original content under the most permissive resize policy in a popup.An instance of this policy must appear exactly once in the list passed to
AbstractRibbonBand.setResizePolicies(java.util.List)
, and it must be the last entry in that list.
-
-
Field Summary
-
Fields inherited from class org.pushingpixels.flamingo.api.ribbon.resize.BaseRibbonBandResizePolicy
controlPanel
-
-
Constructor Summary
Constructors Constructor Description IconRibbonBandResizePolicy(AbstractBandControlPanel controlPanel)
Creates a new collapsed resize policy.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getPreferredWidth(int availableHeight, int gap)
Returns the preferred width of the associated ribbon band under the specified dimensions.void
install(int availableHeight, int gap)
Installs this resize policy on the associated ribbon band.
-
-
-
Constructor Detail
-
IconRibbonBandResizePolicy
public IconRibbonBandResizePolicy(AbstractBandControlPanel controlPanel)
Creates a new collapsed resize policy.- Parameters:
controlPanel
- The control panel of the associated ribbon band.
-
-
Method Detail
-
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.
-
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 display state of the command buttons (withAbstractCommandButton.setDisplayState(org.pushingpixels.flamingo.api.common.CommandButtonDisplayState)
) 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.
-
-