xyz.cofe.gui.swing.menu

Class XmlMenuBuilder

java.lang.Object

xyz.cofe.gui.swing.menu.XmlMenuBuilder

public class XmlMenuBuilder
extends Object

Построение меню по xml.
Формат XML:

<menu> - описывает меню / под меню

Атрибуты / дочерние тэги:
text - отображаемый текст
id - идентификатор
Дочерние тэги: line, action, menu
Пример:

 <menu id="root">
     <menu text="file">
         <action name="file.open"></action>
         <line />
         <action name="exit"></action>
     </menu>
 </menu>
 

<line> - горизонтальная линия

<action> - описывает действие

Обязательный один из указанных атрибутов / дочерние тэги:
name - имя действия, если указано, то будет зайдствовано свойств actionByNameResolver для поиска соответ. действия
class - имя java класса, будет создан соответ экзмепляр
onclick - скрипт который будет вызван для соот. пунктв. Использует actionByOnClickResolver для поиска соответ. действия

Не обязательные атрибуты / дочерние тэги:
onshow - скрипт который будет вызван при отображении меню
target - Цель. Скрипт может быть выполнен без всякой цели, или с определенной целю. Под целю понимается текущий выделенный (сфокусированный javax.swing.FocusManager) объект оопределенного класса.
targetVar - Имя переменной в скрипте которая указывает на цель. По умолчанию - target
actionVar - Имя переменной в скрипте которая на объект javax.swing.Action для данного пункта меню. По умолчанию - action
language / lang - Язык скрипта, по умолчанию JavaScript. Будет передан в actionByOnClickResolver
id - Идентификатор
text - Текст пункта меню
type - тип меню, возможные след. варианты: Default или Checked
desc / shortDesc / title - краткое описание
desc / longDesc - полное описание
key / keyStroke - Комбинация клавиш
ico / icoSmall - Малельная иконка
ico / icoLarge - Большая иконка
iterableTargets - По умолчанию true, - выполнять action (onclick) для каждого элемента

Дочерние тэги: keys

<keys> - описывает комбинации клавиш

Не обязательные атрибуты / дочерние тэги:
key / keyStroke - Комбинация клавиш
target - Окно/Объект (Класс) владеющее фокусом

Комбинация клаиш

Описывается так:
Комбинация клаиш := модификатор* (typedID | pressedReleasedID)
модификатор := shift | control | ctrl | meta | alt | altGraph
typedID := typed typedKey
typedKey := Строка из одного Unicode символа
pressedReleasedID := (pressed | released) key
key := имя KeyEvent, т.е. имя следующее за "VK_"

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlMenuBuilder.MActionItem
static class	XmlMenuBuilder.MContainer
class	XmlMenuBuilder.OnClick
static class	XmlMenuBuilder.RegAction
static class	XmlMenuBuilder.VisitElement

Field Summary

Fields

Modifier and Type	Field and Description
protected Convertor<String,Action>	actionByNameResolver
protected Convertor<XmlMenuBuilder.OnClick,Action>	actionByOnClickResolver
protected Reciver<XmlMenuBuilder.RegAction>	actionReciver
protected boolean	listenTranslation
protected Convertor<String,String>	translate

Constructor Summary

Constructors

Constructor and Description
XmlMenuBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	fireCantCreateAction(Element el)
Convertor<String,Action>	getActionByNameResolver()
Convertor<XmlMenuBuilder.OnClick,Action>	getActionByOnClickResolver()
Reciver<XmlMenuBuilder.RegAction>	getActionReciver()
ScriptEngineManager	getScriptEngineManager()
Convertor<String,String>	getTranslate()
boolean	isListenTranslation()
MenuItem	parseElement(Element el)
protected MenuItem	parseElement(Element el, Stack<XmlMenuBuilder.VisitElement> stack)
protected MenuItem	parseElementAction(Element el)
MenuItem	parseXML(Document xmlDoc) Парсинг XML и создание соот. меню
MenuItem	parseXML(File file) Парсинг XML и создание соот. меню
MenuItem	parseXML(InputStream input) Парсинг XML и создание соот. меню
MenuItem	parseXML(String xml) Создает меню по XML.
MenuItem	parseXML(URL url) Парсинг XML и создание соот. меню
static String	readAttr(Element actionElement, String fieldName, String defaultValue)
static String	readAttrOrText(Element actionElement, String fieldName, String defaultValue)
protected Icon	readIco(String icoString, Element el)
static String	readText(Element actionElement, String fieldName, String defaultValue)
void	setActionByNameResolver(Convertor<String,Action> actionByNameResolver)
void	setActionByOnClickResolver(Convertor<XmlMenuBuilder.OnClick,Action> actionByOnClickResolver)
void	setActionReciver(Reciver<XmlMenuBuilder.RegAction> actionReciver)
void	setListenTranslation(boolean listenTranslation)
void	setScriptEngineManager(ScriptEngineManager scriptEngineManager)
void	setTranslate(Convertor<String,String> translate)
protected String	translate(String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listenTranslation

protected boolean listenTranslation

translate

protected Convertor<String,String> translate

actionByNameResolver

protected Convertor<String,Action> actionByNameResolver

actionByOnClickResolver

protected Convertor<XmlMenuBuilder.OnClick,Action> actionByOnClickResolver

actionReciver

protected Reciver<XmlMenuBuilder.RegAction> actionReciver

Constructor Detail

XmlMenuBuilder

public XmlMenuBuilder()

Method Detail

parseXML

public MenuItem parseXML(URL url)

Парсинг XML и создание соот. меню

Parameters:

url - Ссылка на файл меню

Returns:

Меню

parseXML

public MenuItem parseXML(File file)

Парсинг XML и создание соот. меню

Parameters:

file - Файл

Returns:

Меню

parseXML

public MenuItem parseXML(InputStream input)

Парсинг XML и создание соот. меню

Parameters:

input - XML файл

Returns:

Меню

parseXML

public MenuItem parseXML(String xml)

Создает меню по XML.

Parameters:

xml - XML описание меню

Returns:

Меню либо null

parseXML

public MenuItem parseXML(Document xmlDoc)

Парсинг XML и создание соот. меню

Parameters:

xmlDoc - XML файл

Returns:

Меню

isListenTranslation

public boolean isListenTranslation()

setListenTranslation

public void setListenTranslation(boolean listenTranslation)

getTranslate

public Convertor<String,String> getTranslate()

setTranslate

public void setTranslate(Convertor<String,String> translate)

translate

protected String translate(String text)

parseElement

public MenuItem parseElement(Element el)

parseElement

protected MenuItem parseElement(Element el,
                                Stack<XmlMenuBuilder.VisitElement> stack)

readAttr

public static String readAttr(Element actionElement,
                              String fieldName,
                              String defaultValue)

readText

public static String readText(Element actionElement,
                              String fieldName,
                              String defaultValue)

readAttrOrText

public static String readAttrOrText(Element actionElement,
                                    String fieldName,
                                    String defaultValue)

getActionByNameResolver

public Convertor<String,Action> getActionByNameResolver()

setActionByNameResolver

public void setActionByNameResolver(Convertor<String,Action> actionByNameResolver)

getActionByOnClickResolver

public Convertor<XmlMenuBuilder.OnClick,Action> getActionByOnClickResolver()

setActionByOnClickResolver

public void setActionByOnClickResolver(Convertor<XmlMenuBuilder.OnClick,Action> actionByOnClickResolver)

fireCantCreateAction

protected void fireCantCreateAction(Element el)

getActionReciver

public Reciver<XmlMenuBuilder.RegAction> getActionReciver()

setActionReciver

public void setActionReciver(Reciver<XmlMenuBuilder.RegAction> actionReciver)

getScriptEngineManager

public ScriptEngineManager getScriptEngineManager()

setScriptEngineManager

public void setScriptEngineManager(ScriptEngineManager scriptEngineManager)

parseElementAction

protected MenuItem parseElementAction(Element el)

readIco

protected Icon readIco(String icoString,
                       Element el)