|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.alee.utils.swing.menu.AbstractMenuGenerator<E>
public abstract class AbstractMenuGenerator<E extends javax.swing.JComponent>
This is a base generator class for custom menu generators. Menu generators are made to simplify various Swing menues creation. Possible menu types: WebMenuBar, WebPopupMenu and WebMenu
MenuBarGenerator
,
MenuGenerator
,
PopupMenuGenerator
Field Summary | |
---|---|
protected static java.awt.event.ActionListener |
defaultAction
|
protected static boolean |
defaultEnabled
|
protected static HotkeyData |
defaultHotkey
|
protected static java.lang.Object |
defaultIcon
Default constants used within generator methods. |
protected static java.lang.String |
defaultIconFormat
Default menu icons format. |
protected static boolean |
defaultSelected
|
protected java.lang.String |
extension
Menu icons format. |
protected UnselectableButtonGroup |
group
Buttons grouping. |
protected java.lang.String |
languagePrefix
Menu language key prefix. |
protected E |
menu
Menu component. |
protected java.lang.Class |
nearClass
Class near which menu icons are placed. |
protected java.lang.String |
path
Path to menu icons folder. |
Constructor Summary | |
---|---|
AbstractMenuGenerator(E menu)
Constructs new menu generator with the specified menu component. |
Method Summary | |
---|---|
WebCheckBoxMenuItem |
addCheckItem(java.lang.Object icon,
java.lang.String text,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.Object icon,
java.lang.String text,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
Adds checkbox menu item into menu. |
WebCheckBoxMenuItem |
addCheckItem(java.lang.String text,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.String text,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.String text,
HotkeyData hotkey,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebCheckBoxMenuItem |
addCheckItem(java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.Object icon,
java.lang.String text,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.Object icon,
java.lang.String text,
boolean enabled,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
java.awt.event.ActionListener actionListener)
Adds simple item into menu. |
WebMenuItem |
addItem(java.lang.String text,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.String text,
boolean enabled,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.String text,
HotkeyData hotkey,
java.awt.event.ActionListener actionListener)
|
WebMenuItem |
addItem(java.lang.String text,
HotkeyData hotkey,
boolean enabled,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.Object icon,
java.lang.String text,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.Object icon,
java.lang.String text,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
Adds radio button menu item into menu. |
WebRadioButtonMenuItem |
addRadioItem(java.lang.String text,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.String text,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.String text,
HotkeyData hotkey,
boolean selected,
java.awt.event.ActionListener actionListener)
|
WebRadioButtonMenuItem |
addRadioItem(java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
|
void |
addSeparator()
Adds separator into menu. |
MenuGenerator |
addSubMenu(java.lang.Object icon,
java.lang.String text)
|
MenuGenerator |
addSubMenu(java.lang.Object icon,
java.lang.String text,
java.awt.event.ActionListener actionListener)
|
MenuGenerator |
addSubMenu(java.lang.Object icon,
java.lang.String text,
boolean enabled)
|
MenuGenerator |
addSubMenu(java.lang.Object icon,
java.lang.String text,
boolean enabled,
java.awt.event.ActionListener actionListener)
Adds menu item into menu. |
MenuGenerator |
addSubMenu(java.lang.String text)
|
MenuGenerator |
addSubMenu(java.lang.String text,
java.awt.event.ActionListener actionListener)
|
MenuGenerator |
addSubMenu(java.lang.String text,
boolean enabled)
|
MenuGenerator |
addSubMenu(java.lang.String text,
boolean enabled,
java.awt.event.ActionListener actionListener)
|
UnselectableButtonGroup |
closeGroup()
Finishes grouping menu items. |
protected WebCheckBoxMenuItem |
createCheckItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
Returns newly created checkbox menu item. |
protected WebMenuItem |
createItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
java.awt.event.ActionListener actionListener)
Returns newly created menu item. |
protected WebRadioButtonMenuItem |
createRadioItem(java.lang.Object icon,
java.lang.String text,
HotkeyData hotkey,
boolean enabled,
boolean selected,
java.awt.event.ActionListener actionListener)
Returns newly created radio button menu item. |
protected WebMenu |
createSubMenu(java.lang.Object icon,
java.lang.String text,
boolean enabled,
java.awt.event.ActionListener actionListener)
Returns newly created menu. |
java.lang.String |
getExtension()
Returns menu icons format. |
javax.swing.ImageIcon |
getIcon(java.lang.Object icon)
Returns icon for the specified name. |
java.lang.String |
getLanguageKey(java.lang.String text)
Returns menu item language key for the specified name. |
java.lang.String |
getLanguagePrefix()
Returns menu language key prefix. |
E |
getMenu()
Returns menu component. |
java.lang.Class |
getNearClass()
Returns class near which menu icons are placed. |
java.lang.String |
getPath()
Returns path to menu icons folder relative to class. |
UnselectableButtonGroup |
group(javax.swing.AbstractButton button)
Adds custom button into currently used buttons group. |
boolean |
isEmpty()
Returns whether menu is empty or not. |
UnselectableButtonGroup |
openGroup()
Starts grouping menu items. |
UnselectableButtonGroup |
openGroup(boolean unselectable)
Starts grouping menu items. |
void |
setExtension(java.lang.String extension)
Sets menu icons format. |
void |
setIconSettings(java.lang.Class nearClass,
java.lang.String path,
java.lang.String extension)
Sets menu icons location and format. |
void |
setIconSettings(java.lang.String path,
java.lang.String extension)
Sets menu icons location and format. |
void |
setLanguagePrefix(java.lang.String prefix)
Sets menu language key prefix. |
void |
setNearClass(java.lang.Class nearClass)
Sets class near which menu icons are placed. |
void |
setPath(java.lang.String path)
Sets path to menu icons folder relative to class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.Object defaultIcon
protected static final HotkeyData defaultHotkey
protected static final boolean defaultEnabled
protected static final boolean defaultSelected
protected static final java.awt.event.ActionListener defaultAction
protected static final java.lang.String defaultIconFormat
protected java.lang.Class nearClass
protected java.lang.String path
protected java.lang.String extension
protected java.lang.String languagePrefix
protected UnselectableButtonGroup group
protected E extends javax.swing.JComponent menu
Constructor Detail |
---|
public AbstractMenuGenerator(E menu)
Method Detail |
---|
public java.lang.Class getNearClass()
public void setNearClass(java.lang.Class nearClass)
nearClass
- class near which menu icons are placedpublic java.lang.String getPath()
public void setPath(java.lang.String path)
path
- path to menu icons folder relative to classpublic java.lang.String getExtension()
public void setExtension(java.lang.String extension)
extension
- menu icons formatpublic void setIconSettings(java.lang.String path, java.lang.String extension)
path
- path to menu icons folder in file systemextension
- menu icons formatpublic void setIconSettings(java.lang.Class nearClass, java.lang.String path, java.lang.String extension)
nearClass
- class near which menu icons are placedpath
- path to menu icons folder relative to classextension
- menu icons formatpublic java.lang.String getLanguagePrefix()
public void setLanguagePrefix(java.lang.String prefix)
prefix
- menu language key prefixpublic java.lang.String getLanguageKey(java.lang.String text)
text
- menu item name or text
public void addSeparator()
public WebMenuItem addItem(java.lang.String text, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.String text, HotkeyData hotkey, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.String text, boolean enabled, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.String text, HotkeyData hotkey, boolean enabled, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.Object icon, java.lang.String text, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.Object icon, java.lang.String text, boolean enabled, java.awt.event.ActionListener actionListener)
public WebMenuItem addItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, java.awt.event.ActionListener actionListener)
icon
- menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- menu item texthotkey
- menu item acceleratorenabled
- whether menu item is enabled or notactionListener
- menu item action listener
protected WebMenuItem createItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, java.awt.event.ActionListener actionListener)
icon
- menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- menu item texthotkey
- menu item acceleratorenabled
- whether menu item is enabled or notactionListener
- menu item action listener
public WebCheckBoxMenuItem addCheckItem(java.lang.String text, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.String text, HotkeyData hotkey, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.String text, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.Object icon, java.lang.String text, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.Object icon, java.lang.String text, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebCheckBoxMenuItem addCheckItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
icon
- checkbox menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- checkbox menu item texthotkey
- checkbox menu item acceleratorenabled
- whether checkbox menu item is enabled or notselected
- whether checkbox menu item is selected or notactionListener
- checkbox menu item action listener
protected WebCheckBoxMenuItem createCheckItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
icon
- checkbox menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- checkbox menu item texthotkey
- checkbox menu item acceleratorenabled
- whether checkbox menu item is enabled or notselected
- whether checkbox menu item is selected or notactionListener
- checkbox menu item action listener
public WebRadioButtonMenuItem addRadioItem(java.lang.String text, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.String text, HotkeyData hotkey, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.String text, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.Object icon, java.lang.String text, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.Object icon, java.lang.String text, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
public WebRadioButtonMenuItem addRadioItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
icon
- radio button menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- radio button menu item texthotkey
- radio button menu item acceleratorenabled
- whether radio button menu item is enabled or notselected
- whether radio button menu item is selected or notactionListener
- radio button menu item action listener
protected WebRadioButtonMenuItem createRadioItem(java.lang.Object icon, java.lang.String text, HotkeyData hotkey, boolean enabled, boolean selected, java.awt.event.ActionListener actionListener)
icon
- radio button menu item icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- radio button menu item texthotkey
- radio button menu item acceleratorenabled
- whether radio button menu item is enabled or notselected
- whether radio button menu item is selected or notactionListener
- radio button menu item action listener
public MenuGenerator addSubMenu(java.lang.String text)
public MenuGenerator addSubMenu(java.lang.String text, boolean enabled)
public MenuGenerator addSubMenu(java.lang.String text, java.awt.event.ActionListener actionListener)
public MenuGenerator addSubMenu(java.lang.String text, boolean enabled, java.awt.event.ActionListener actionListener)
public MenuGenerator addSubMenu(java.lang.Object icon, java.lang.String text)
public MenuGenerator addSubMenu(java.lang.Object icon, java.lang.String text, boolean enabled)
public MenuGenerator addSubMenu(java.lang.Object icon, java.lang.String text, java.awt.event.ActionListener actionListener)
public MenuGenerator addSubMenu(java.lang.Object icon, java.lang.String text, boolean enabled, java.awt.event.ActionListener actionListener)
icon
- menu icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- menu textenabled
- whether menu is enabled or notactionListener
- menu action listener
protected WebMenu createSubMenu(java.lang.Object icon, java.lang.String text, boolean enabled, java.awt.event.ActionListener actionListener)
icon
- menu icon, can be either String icon name, ImageIcon, Image, image File or image URLtext
- menu textenabled
- whether menu is enabled or notactionListener
- menu action listener
public UnselectableButtonGroup openGroup()
closeGroup()
call will get grouped.
public UnselectableButtonGroup openGroup(boolean unselectable)
closeGroup()
call will get grouped.
unselectable
- whether items should be unselectable or not
public UnselectableButtonGroup group(javax.swing.AbstractButton button)
button
- custom button to add into buttons group
public UnselectableButtonGroup closeGroup()
public javax.swing.ImageIcon getIcon(java.lang.Object icon)
icon
- can be either String icon name, ImageIcon, Image, image File or image URL
public E getMenu()
public boolean isEmpty()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |