dorkbox.systemTray.Separator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SystemTray Show documentation

Cross-platform SystemTray support for Swing/AWT, GtkStatusIcon, and AppIndicator on Java 8+

The newest version!

/*
 * Copyright 2021 dorkbox, llc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dorkbox.systemTray;

import java.awt.Component;

import javax.swing.JSeparator;

import dorkbox.systemTray.peer.SeparatorPeer;
import dorkbox.systemTray.util.ImageResizeUtil;

/**
 * This represents a common menu-spacer entry, that is cross platform in nature.
 * 
 * When menu entries are removed, any menu spacer that ends up at the top/bottom of the menu will also be removed.
 * 

 * For example:
 * 
 {@code
 * Original     Entry3 deleted     Result
 *
 *                 
 * Entry1           Entry1         Entry1
 * Entry2      ->   Entry2    ->   Entry2
 *          (deleted)
 * Entry3           (deleted)
 *
 * }
 */
public
class Separator extends Entry {

    public
    Separator() {
        super();
    }

    /**
     * @param peer the platform specific implementation for all actions for this type
     * @param parent the parent of this menu, null if the parent is the system tray
     * @param imageResizeUtil the utility used to resize images. This can be Tray specific because of cache requirements
     */
    public
    void bind(final SeparatorPeer peer, final Menu parent, ImageResizeUtil imageResizeUtil) {
        super.bind(peer, parent, imageResizeUtil);
    }


    /**
     * @return a copy of this Separator as a swing JSeparator, with all elements converted to their respective swing elements.
     */
    public
    Component asSwingComponent() {
        return new JSeparator();
    }
}