01: /*
02: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
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.
13: *
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.
17: *
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.
29: */
30: package org.jvnet.substance;
31:
32: import java.awt.Font;
33:
34: import javax.swing.Icon;
35: import javax.swing.JMenuItem;
36:
37: /**
38: * Base interface for all menu-related UI delegates.
39: *
40: * @author Kirill Grouchnikov
41: */
42: public interface SubstanceMenu {
43: /**
44: * Name for internal client property that holds the cached text offset.
45: */
46: //public static final String SINGLE_MENU_TEXT_OFFSET = "substancelaf.internal.singleMenuTextOffset";
47: /**
48: * Returns the font of the accelerator string of <code>this</code> UI
49: * delegate.
50: *
51: * @return The font of the accelerator string of <code>this</code> UI
52: * delegate.
53: */
54: public Font getAcceleratorFont();
55:
56: /**
57: * Returns the checkmark icon of <code>this</code> UI delegate.
58: *
59: * @return The checkmark icon of <code>this</code> UI delegate.
60: */
61: public Icon getCheckIcon();
62:
63: /**
64: * Returns the arrow icon of <code>this</code> UI delegate.
65: *
66: * @return The arrow icon of <code>this</code> UI delegate.
67: */
68: public Icon getArrowIcon();
69:
70: /**
71: * Returns the default gap between the icon and the text for
72: * <code>this</code> delegate.
73: *
74: * @return The default gap between the icon and the text for
75: * <code>this</code> delegate.
76: */
77: public int getDefaultTextIconGap();
78:
79: /**
80: * Returns the associated menu item.
81: *
82: * @return The associated menu item.
83: */
84: public JMenuItem getAssociatedMenuItem();
85: }
|