JRibbon - First Program

In this post I’m tell you Step by step how to implements JRibbon in your Application.

Note:  To begging the implement your JRibbon Frame you need to first Design your Ribbon Menu. Then go to implementation because implementation is happened in reverse direction of structure means you need to implements JRibbonBand First then JRibbonBand is Added into RibbonTask and Finally RibbonTask add in to Ribbon.

Step 1:

First of all when your start window based application you extends your class with JFrame. But in this application you need to extends your class with JRibbonFrame.

public  class ClassName extends JRibbonFrame

When you run your application

                                ClassName className = new ClassName();

                className.setSize(300,300);

                className.setVisible(true);

It look like this :

Step 2:

Create JRibbonBand and add some components in to JRibbonBand. JRibbonBand can created using two way.

A :

JRibbonBand clipboardBand = new JRibbonBand("Clipboard",                                            getResizableIconFromResource(new URL(“clipboard.png”)));

In this method creating a JRibbonBand pass two argument first is Name of your band and second is resizable icon for your band. ResizableIcon Details

B :

JRibbonBand clipboardBand = new JRibbonBand("Clipboard",                    getResizableIconFromResource(new URL(“clipboard.png”)), new ActionListener()

            @Override

            public void actionPerformed(ActionEvent e) {

            }

        });

In this method creating a JRibbonBand pass three argument first is Name of your band, second is resizable icon for your band and third is ActionListener for ExpandKey (explain below).

Step 3:

Now add ExpandKeyTip for you band.

clipboardBand.setExpandButtonKeyTip("FO");

What is ExpandKeyTip ?

ExpandKeyTip is an action trigger for your Expand Key.

When you press and ALT key JRibbon will display all mnemonics for  all Task, Components, and Expand Buttons.

In this case you press FO, ActionEvent Trigger Fire.

Step 4:

Now create a component for adding into JRibbonBand.

For JRibbon you not use an component like JButton, JCheckbox, JCombox.

JRibbon Provide its own components.

JCommandButton work as JButton

JCommandButton pasteButton = new JCommandButton("Paste", getResizableIconFromResource(new URL(“paste.png”))));

For JCommandButton two argument are passed, first is name of button and second is resizable icons for button

Step 5: 

Additional properties of JCommandButton :

Just like ExpandKeyTip JCommandButton having ActionKeyTip

pasteButton .setActionKeyTip("V");

ActionListener for JCommandButton

pasteButton.addActionListener(new ActionListener() {

            @Override

            public void actionPerformed(ActionEvent e) {

               

            }

        });

 Step 6:

Setup an RichToolTip for JCommandButton .

Step 7:

Now add JCommandButton to JRibbonBand

clipboardBand.addCommandButton(pasteButton, RibbonElementPriority.TOP);

During  add JCommandButton we need to specify an Priority of RibbonComponents.

RibbonElementPriority.TOP

RibbonElementPriority.MEDIUM

RibbonElementPriority.LOW

Step 8:

Before adding JRibbonBand to RibbonTask you need to set Resizing policy for JRibbonBand

List<RibbonBandResizePolicy> resizePolicies = new ArrayList<RibbonBandResizePolicy>();

resizePolicies.add(

new CoreRibbonResizePolicies.Mirror(clipboardBand.getControlPanel()));

resizePolicies.add(

new CoreRibbonResizePolicies.Mid2Low(clipboardBand.getControlPanel()));

clipboardBand.setResizePolicies(resizePolicies);

Step 9:

Now Create RibbonTask and add JRibbonBand in that RibbonTask.

RibbonTask homeTask = new RibbonTask("Home", clipboardBand);

To add another band in this homeTask just appends new Band in declaration of Task.

e.g.

RibbonTask homeTask = new RibbonTask("Home", clipboardBand, newBand, anohterNewBand);

Step 10:

And finally add Task to Ribbon

this.getRibbon().addTask(homeTask);

Step 11:

When you run it look like