Package org.pushingpixels.flamingo.api.ribbon.resize

Class CoreRibbonResizePolicies

java.lang.Object

org.pushingpixels.flamingo.api.ribbon.resize.CoreRibbonResizePolicies

public class CoreRibbonResizePolicies
extends java.lang.Object

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

• Resize policies for the JFlowRibbonBands. The CoreRibbonResizePolicies.FlowTwoRows and CoreRibbonResizePolicies.FlowThreeRows allow placing the flow ribbon band content in two and three rows respectively.
• Resize policies for the JRibbonBands. The CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy is the base class for these policies. These policies respect the JRibbonBand.PresentationPriority associated with command buttons and ribbon galleries in RibbonBandResizePolicy.getPreferredWidth(int, int) and RibbonBandResizePolicy.install(int, int). While RibbonBandResizePolicy.install(int, int) call on a JFlowRibbonBand only changes the bounds of the flow components, this call on a JRibbonBand can also change the presentation state of the command buttons (with JCommandButton.setPresentationState(CommandButtonPresentationState) ) and the number of visible buttons in the ribbon galleries.
• The collapsed policy that replaces the entire content of the ribbon band with a single popup button. This is done when there is not enough horizontal space to show the content of the ribbon band under the most restrictive resize policy. Activating the popup button will show the original content under the most permissive resize policy in a popup. This policy is implemented in the CoreRibbonResizePolicies.IconRibbonBandResizePolicy.

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

• getCorePoliciesPermissive(JRibbonBand) returns a list that starts with a resize policy that shows all command buttons in the CommandButtonPresentationState.BIG and ribbon galleries with the largest number of visible buttons, fully utilizing the available screen space.
• getCorePoliciesRestrictive(JRibbonBand) returns a list that starts with a resize policy that respects the associated ribbon element priority set on the specific components.
• getCorePoliciesNone(JRibbonBand) returns a list that only has a mirror resize policy that respects the associated ribbon element priority set on the specific components.

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

In addition, the 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoreRibbonResizePolicies.BaseCoreRibbonBandResizePolicy	The base class for mapping-based core resize policies.
static class	CoreRibbonResizePolicies.BaseRibbonBandResizePolicy<B extends AbstractRibbonBand>
static class	CoreRibbonResizePolicies.FlowThreeRows	Core resize policy for JFlowRibbonBand that places the content in three rows.
static class	CoreRibbonResizePolicies.FlowTwoRows	Core resize policy for JFlowRibbonBand that places the content in two rows.
static class	CoreRibbonResizePolicies.High2Low	Core resize policy that maps all JRibbonBand.PresentationPrioritys to JRibbonBand.PresentationPriority.LOW.
static class	CoreRibbonResizePolicies.High2Mid	Core resize policy that maps: JRibbonBand.PresentationPriority.TOP -> JRibbonBand.PresentationPriority.MEDIUM JRibbonBand.PresentationPriority.MEDIUM -> JRibbonBand.PresentationPriority.LOW JRibbonBand.PresentationPriority.LOW -> JRibbonBand.PresentationPriority.LOW
static class	CoreRibbonResizePolicies.IconRibbonBandResizePolicy	Special resize policy that is used for collapsed ribbon bands.
static class	CoreRibbonResizePolicies.Low2Mid	Core resize policy that maps: JRibbonBand.PresentationPriority.TOP -> JRibbonBand.PresentationPriority.TOP JRibbonBand.PresentationPriority.MEDIUM -> JRibbonBand.PresentationPriority.TOP JRibbonBand.PresentationPriority.LOW -> JRibbonBand.PresentationPriority.MEDIUM
static class	CoreRibbonResizePolicies.Mid2Low	Core resize policy that maps: JRibbonBand.PresentationPriority.TOP -> JRibbonBand.PresentationPriority.TOP JRibbonBand.PresentationPriority.MEDIUM -> JRibbonBand.PresentationPriority.LOW JRibbonBand.PresentationPriority.LOW -> JRibbonBand.PresentationPriority.LOW
static class	CoreRibbonResizePolicies.Mid2Mid	Core resize policy that maps: JRibbonBand.PresentationPriority.TOP -> JRibbonBand.PresentationPriority.TOP JRibbonBand.PresentationPriority.MEDIUM -> JRibbonBand.PresentationPriority.MEDIUM JRibbonBand.PresentationPriority.LOW -> JRibbonBand.PresentationPriority.MEDIUM
static class	CoreRibbonResizePolicies.Mirror	Mirror core resize policy that maps the values of JRibbonBand.PresentationPrioritys to themselves.
static class	CoreRibbonResizePolicies.None	Core resize policy that maps all JRibbonBand.PresentationPrioritys to JRibbonBand.PresentationPriority.TOP.

Constructor Summary

Constructors

Constructor	Description
CoreRibbonResizePolicies()

Method Summary

Modifier and Type	Method	Description
static java.util.List<RibbonBandResizePolicy>	getCoreFlowPoliciesRestrictive(JFlowRibbonBand ribbonBand, int stepsToRepeat)	Returns a list that has CoreRibbonResizePolicies.FlowTwoRows policy followed by the CoreRibbonResizePolicies.FlowThreeRows resize policy.
static java.util.List<RibbonBandResizePolicy>	getCorePoliciesNone(JRibbonBand ribbonBand)	Returns a list that only has a mirror resize policy that respects the associated ribbon element priority set on the specific components.
static java.util.List<RibbonBandResizePolicy>	getCorePoliciesPermissive(JRibbonBand ribbonBand)	Returns a list that starts with a resize policy that shows all command buttons in the CommandButtonPresentationState.BIG and ribbon galleries with the largest number of visible buttons.
static java.util.List<RibbonBandResizePolicy>	getCorePoliciesRestrictive(JRibbonBand ribbonBand)	Returns a list that starts with a resize policy that respects the associated ribbon element priority set on the specific components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoreRibbonResizePolicies

public CoreRibbonResizePolicies()

Method Detail

getCorePoliciesPermissive

public static java.util.List<RibbonBandResizePolicy> getCorePoliciesPermissive(JRibbonBand ribbonBand)

Returns a list that starts with a resize policy that shows all command buttons in the CommandButtonPresentationState.BIG and ribbon galleries with the largest number of visible buttons. The last entry is the CoreRibbonResizePolicies.IconRibbonBandResizePolicy.

Parameters:

ribbonBand - Ribbon band.

Returns:

The permissive list of core ribbon band resize policies.

getCorePoliciesRestrictive

public static java.util.List<RibbonBandResizePolicy> getCorePoliciesRestrictive(JRibbonBand ribbonBand)

Returns a list that starts with a resize policy that respects the associated ribbon element priority set on the specific components. The last entry is the CoreRibbonResizePolicies.IconRibbonBandResizePolicy.

Parameters:

ribbonBand - Ribbon band.

Returns:

The restrictive list of core ribbon band resize policies.

getCorePoliciesNone

public static java.util.List<RibbonBandResizePolicy> getCorePoliciesNone(JRibbonBand ribbonBand)

Returns a list that only has a mirror resize policy that respects the associated ribbon element priority set on the specific components. The last entry is the CoreRibbonResizePolicies.IconRibbonBandResizePolicy.

Parameters:

ribbonBand - Ribbon band.

Returns:

The mirror list of core ribbon band resize policies.

getCoreFlowPoliciesRestrictive

public static java.util.List<RibbonBandResizePolicy> getCoreFlowPoliciesRestrictive(JFlowRibbonBand ribbonBand,
                                                                                    int stepsToRepeat)

Returns a list that has CoreRibbonResizePolicies.FlowTwoRows policy followed by the CoreRibbonResizePolicies.FlowThreeRows resize policy. The last entry is the CoreRibbonResizePolicies.IconRibbonBandResizePolicy.

Parameters:

ribbonBand - Ribbon band.

stepsToRepeat - The number of times each one of the CoreRibbonResizePolicies.FlowTwoRows / CoreRibbonResizePolicies.FlowThreeRows should appear consecutively in the returned list.

Returns:

The restrictive list of core ribbon band resize policies.