org.pushingpixels.flamingo.api.ribbon.resize
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
restructive RibbonBandResizePolicy
, 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.
Method Summary |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
IconRibbonBandResizePolicy
public IconRibbonBandResizePolicy(AbstractBandControlPanel controlPanel)
- Creates a new collapsed resize policy.
- Parameters:
controlPanel
- The control panel of the associated ribbon band.
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. For
JFlowRibbonBand
s only changes the bounds of the flow components.
For JRibbonBand
s can also change the display state of the command
buttons (with
AbstractCommandButton.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.