Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 3.87 KB

CommandStrip.md

File metadata and controls

76 lines (53 loc) · 3.87 KB
Raw

Flamingo - command strips

Command strip is a logically and visually connected group of commands (and their projections). In the screenshot below the four styling commands - bold, italic, underline, strikethrough - are grouped together to reinforce the logical connection of the underlying functionality.

Content model

org.pushingpixels.flamingo.api.common.model.CommandGroup is the content model for command strips. A variety of constructors are available to set the initial command content. In addition, commands can be added to and removed from a command group dynamically.

Presentation model

org.pushingpixels.flamingo.api.common.model.CommandStripPresentationModel and its Builder are the presentation model for command button strips.

The orientation attribute can be used to specify whether the strip buttons should be laid out horizontally or vertically.

The commandPresentationState attribute determines the visual presentation of the strip commands in the projected buttons. In the screenshot below, the same CommandGroup is projected using three different CommandStripPresentationModel instances - each one differing only in its command presentation state:

The horizontalGapScaleFactor and verticalGapScaleFactor can be used to control the space around the icons of the projected buttons:

The flat attribute controls the background presence of all projected buttons in default (non-active state).

Projection

org.pushingpixels.flamingo.api.common.projection.CommandStripProjection is the projection that combines CommandGroup content model and CommandStripPresentationModel presentation model. The result of buildComponent is a Swing component of the JCommandButtonStrip class.

Sample code

First we create four commands configured to belong to the same command toggle group:

CommandToggleGroupModel justifyToggleGroup = new CommandToggleGroupModel();

Command justifyLeft = Command.builder()
    .setText("left")
    .setIconFactory(Format_justify_left.factory())
    .inToggleGroupAsSelected(justifyToggleGroup)
    .build();
Command justifyCenter = Command.builder()
    .setText("center")
    .setIconFactory(Format_justify_center.factory())
    .inToggleGroup(justifyToggleGroup)
    .build();
Command justifyRight = Command.builder()
    .setText("right")
    .setIconFactory(Format_justify_right.factory())
    .inToggleGroup(justifyToggleGroup)
    .build();
Command justifyFill = Command.builder()
    .setText("fill")
    .setIconFactory(Format_justify_fill.factory())
    .inToggleGroup(justifyToggleGroup)
    .build();

And then we create a CommandGroup content model and a CommandStripPresentationModel presentation model, combine them together into a CommandStripProjection and then call buildComponent() to get a Swing component that can be added to the component hierarchy of our application:

CommandGroup justifyCommandGroup =
    new CommandGroup(justifyLeft, justifyCenter, justifyRight, justifyFill);
contentPanel.add(new CommandStripProjection(justifyCommandGroup,
    CommandStripPresentationModel.builder()
        .setCommandPresentationState(CommandButtonPresentationState.SMALL)
        .build())
    .buildComponent());

Next

Continue to command panels.