Interface RibbonBandResizePolicy

All Known Implementing Classes:
CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy, CoreRibbonResizePolicies.BaseRibbonBandResizePolicy, CoreRibbonResizePolicies.FlowOneRow, CoreRibbonResizePolicies.FlowThreeRows, CoreRibbonResizePolicies.FlowTwoRows, CoreRibbonResizePolicies.High2Low, CoreRibbonResizePolicies.High2Mid, CoreRibbonResizePolicies.IconRibbonBandResizePolicy, CoreRibbonResizePolicies.Low2Mid, CoreRibbonResizePolicies.Mid2Low, CoreRibbonResizePolicies.Mid2Mid, CoreRibbonResizePolicies.Mirror, CoreRibbonResizePolicies.None

public interface RibbonBandResizePolicy
Defines the resize policies for the JRibbonBands and JFlowRibbonBands.

The resize policy defines a single visual state of the given ribbon band. For every control in the specific ribbon band (command button, gallery etc), the resize policy defines what is its presentation state.

The resize policies are installed with AbstractRibbonBand.setResizePolicies(java.util.List) API. The order of the resize policies in this list is important. The first entry in the list must be the most permissive policy that returns the largest value from its getPreferredWidth(int, int). Each successive entry in the list must return the value smaller than its predecessors.

As the ribbon horizontal size is changed (by the user resizing the application window), the ribbon task resize sequencing policy set by RibbonTask.setResizeSequencingPolicy(RibbonBandResizeSequencingPolicy) determines the order of ribbon bands to shrink / expand. See more details in the documentation of the RibbonBandResizeSequencingPolicy.

The CoreRibbonResizePolicies provides a number of built in resize policies that respect the application element priorities passed to JRibbonBand.addRibbonCommand(BaseCommandButtonProjection, JRibbonBand.PresentationPriority) and JRibbonBand.addRibbonGallery(RibbonGalleryProjection, JRibbonBand.PresentationPriority) APIs. There are three types of built in resize policies:

In addition to the specific resize policies, the CoreRibbonResizePolicies provides three core resize policies lists for JRibbonBands:

Note that as mentioned above, all the three lists above have the collapsed policy as their last element.

In addition, the CoreRibbonResizePolicies.getCoreFlowPoliciesRestrictive(JFlowRibbonBand, int) returns a restrictive resize policy for JFlowRibbonBands. The list starts with the two-row policy, goes to the three-row policy and then finally to the collapsed policy.

  • Method Summary

    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.
  • Method Details

    • getPreferredWidth

      int getPreferredWidth(int availableHeight, int gap)
      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

      void install(int availableHeight, int gap)
      Installs this resize policy on the associated ribbon band. For JFlowRibbonBands only changes the bounds of the flow components. For JRibbonBands can also change the presentation state of the command buttons (with JCommandButton.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.