/jsplitbutton

A split button control for Java Swing.

Primary LanguageJavaApache License 2.0Apache-2.0

JSplitButton

A split button control for Java Swing.

JitPack Javadocs Build CodeQL Quality Gate Status Maintainability Rating codecov OpenSSF Scorecard

A simple implementation of the split button control for Java Swing. This control raises two events:

  • buttonClicked(ActionEvent e)
  • splitButtonClicked(ActionEvent e)

The buttonClicked event is raised when the main, or left, part of the button is clicked, which will not trigger the popup menu. The splitButtonClicked event is raised when the split, or right, part of the button is clicked and displays a popup menu.

To handle these events you need a listener that implements:

  • SplitButtonActionListener to handle both events in a single listener
  • ButtonClickedActionListener to handle just buttonClicked
  • SplitButtonClickedActionListener to handle just splitButtonClicked

See also http://naveedmurtuza.blogspot.ch/2010/11/jsplitbutton.html

Screenshots

alt tag

alt tag

alt tag

Using the Control

//first instantiate the control
JSplitButton splitButton = new JSplitButton();
//register for listener
splitButton.addSplitButtonActionListener(new SplitButtonActionListener() {

    public void buttonClicked(ActionEvent e) {
        System.out.println("Button Clicked");
    }

    public void splitButtonClicked(ActionEvent e) {
        System.out.println("Split Part Clicked");
    }
});
//add popup menu
splitButton.add(popupMenu);
//add this control to panel
panel.add(splitButton);

or (using Java 8 lambda expressions):

//first instantiate the control
JSplitButton splitButton = new JSplitButton();
//register for button listener
splitButton.addButtonClickedActionListener((ActionEvent e) -> {
    System.out.println("Button Clicked");
});
//register for split button listener
splitButton.addSplitButtonClickedActionListener((ActionEvent e) -> {
    System.out.println("Split Part Clicked");
});
//add popup menu
splitButton.add(popupMenu);
//add this control to panel
panel.add(splitButton);

Including in your project

Gradle

  1. Add the Jitpack repository to build.gradle
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
  1. Add the dependency
dependencies {
    implementation 'com.github.rhwood:jsplitbutton:Tag'
}

Maven

  1. Add the Jitpack repository to pom.xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
  1. Add the dependency
<dependency>
    <groupId>com.github.rhwood</groupId>
    <artifactId>jsplitbutton</artifactId>
    <version>Tag</version>
</dependency>

Migrating from Version 1.x to 2.0 or Newer

  1. Add the Jitpack.io repositoras shown above
  2. Change the Group ID in pom.xml or build.gradle from com.alexandriasoftware.swing to com.github.rhwood.jsplitbutton
  3. Change the package name in imports from com.alexandriasoftware.swing to com.github.rhwood.jsplitbutton

License

Prior History