2
* Copyright (c) 2005-2010 Substance Kirill Grouchnikov. All Rights Reserved.
4
* Redistribution and use in source and binary forms, with or without
5
* modification, are permitted provided that the following conditions are met:
7
* o Redistributions of source code must retain the above copyright notice,
8
* this list of conditions and the following disclaimer.
10
* o Redistributions in binary form must reproduce the above copyright notice,
11
* this list of conditions and the following disclaimer in the documentation
12
* and/or other materials provided with the distribution.
14
* o Neither the name of Substance Kirill Grouchnikov nor the names of
15
* its contributors may be used to endorse or promote products derived
16
* from this software without specific prior written permission.
18
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
package org.pushingpixels.substance.internal.utils.menu;
34
import javax.swing.Icon;
35
import javax.swing.JMenuItem;
38
* Base interface for all menu-related UI delegates.
40
* @author Kirill Grouchnikov
42
public interface SubstanceMenu {
44
* Name for internal client property that holds the cached text offset.
46
// public static final String SINGLE_MENU_TEXT_OFFSET =
47
// "substancelaf.internal.singleMenuTextOffset";
49
* Returns the font of the accelerator string of <code>this</code> UI
52
* @return The font of the accelerator string of <code>this</code> UI
55
public Font getAcceleratorFont();
58
* Returns the checkmark icon of <code>this</code> UI delegate.
60
* @return The checkmark icon of <code>this</code> UI delegate.
62
public Icon getCheckIcon();
65
* Returns the arrow icon of <code>this</code> UI delegate.
67
* @return The arrow icon of <code>this</code> UI delegate.
69
public Icon getArrowIcon();
72
* Returns the default gap between the icon and the text for
73
* <code>this</code> delegate.
75
* @return The default gap between the icon and the text for
76
* <code>this</code> delegate.
78
public int getDefaultTextIconGap();
81
* Returns the associated menu item.
83
* @return The associated menu item.
85
public JMenuItem getAssociatedMenuItem();