org.pushingpixels.substance.internal.utils.menu.SubstanceMenu Maven / Gradle / Ivy
/*
* Copyright (c) 2005-2020 Radiance Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of the copyright holder nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.substance.internal.utils.menu;
import javax.swing.*;
import java.awt.*;
/**
* Base interface for all menu-related UI delegates.
*
* @author Kirill Grouchnikov
*/
public interface SubstanceMenu {
/**
* Returns the font of the accelerator string of this UI
* delegate.
*
* @return The font of the accelerator string of this UI
* delegate.
*/
Font getAcceleratorFont();
/**
* Returns the checkmark icon of this UI delegate.
*
* @return The checkmark icon of this UI delegate.
*/
Icon getCheckIcon();
/**
* Returns the arrow icon of this UI delegate.
*
* @return The arrow icon of this UI delegate.
*/
Icon getArrowIcon();
/**
* Returns the default gap between the icon and the text for
* this delegate.
*
* @return The default gap between the icon and the text for
* this delegate.
*/
int getDefaultTextIconGap();
/**
* Returns the associated menu item.
*
* @return The associated menu item.
*/
JMenuItem getAssociatedMenuItem();
void updateCheckIconIfNeeded();
}