org.weda.action
Interface ActionDescriptor

All Known Implementing Classes:

ActionDescriptorImpl

public interface ActionDescriptor

Цель: предосталение инфмации о действии.

Author:

tim

Method Summary

void	addActionParameter(ActionParameter actionParameter) Метод устанавливает описание свойств значения которых нужно установить перед выполнением действия.
void	addActionParameterValue(ActionParameterValue propertyValue) Метод добавляет пару свойство действия, значение.
java.lang.String	getAccessKey() Метод возвращает символ при нажатии на который вместе с клавишей Alt (на PC платформе) будет выполнено действие описываемое данным дескриптором.
java.lang.Class	getActionClass() Метод возвращает класс действия.
ActionParameter	getActionParameter(java.lang.String name) Метод вернет описание параметра по его имени.
java.util.List<ActionParameter>	getActionParameters() Метод возвращает описание свойств значения которых нужно установить или прочитать перед выполнением действия.
java.lang.String	getDescription() Метод возвращет краткое описание действия.
java.util.List<LinkedAction>	getLinkedActions() Метод возвращает действия связанные с данным.
java.lang.String	getName() Метод возвращает название действия.
java.util.Set<ActionTargetClass>	getTargetClasses() Метод возвращает список классов над которыми действие может быть выполнено.
java.lang.String	getTargetFrame() Метод возвращает имя фрейма в котором будет отображен результат действия.
void	init()
void	setActionParametersValues(java.lang.Object action) Метод устанавливает значения свойств объекта действия.
void	setMessages(Messages messages) Метод устанавливает объект дающий доступ к локализированным сообщениям в разрезе класса действия ({@link #getActionClass()).

Method Detail

init

void init()
          throws ActionDescriptorException

Throws:

ActionDescriptorException

getName

java.lang.String getName()

Метод возвращает название действия.

getDescription

java.lang.String getDescription()

Метод возвращет краткое описание действия.

getActionClass

java.lang.Class getActionClass()

Метод возвращает класс действия.

getAccessKey

java.lang.String getAccessKey()

Метод возвращает символ при нажатии на который вместе с клавишей Alt (на PC платформе) будет выполнено действие описываемое данным дескриптором.

getActionParameters

java.util.List<ActionParameter> getActionParameters()

Метод возвращает описание свойств значения которых нужно установить или прочитать перед выполнением действия.

getActionParameter

ActionParameter getActionParameter(java.lang.String name)
                                   throws ActionDescriptorException

Метод вернет описание параметра по его имени.

Throws:

ActionDescriptorException - если в действии нет указаного параметра.

getTargetFrame

java.lang.String getTargetFrame()

Метод возвращает имя фрейма в котором будет отображен результат действия.

addActionParameter

void addActionParameter(ActionParameter actionParameter)

Метод устанавливает описание свойств значения которых нужно установить перед выполнением действия.

getTargetClasses

java.util.Set<ActionTargetClass> getTargetClasses()

Метод возвращает список классов над которыми действие может быть выполнено.

getLinkedActions

java.util.List<LinkedAction> getLinkedActions()

Метод возвращает действия связанные с данным.

setMessages

void setMessages(Messages messages)

Метод устанавливает объект дающий доступ к локализированным сообщениям в разрезе класса действия ({@link #getActionClass()). Т.е. messages является подмножеством сообщений actions:action_class

addActionParameterValue

void addActionParameterValue(ActionParameterValue propertyValue)

Метод добавляет пару свойство действия, значение. Значения свойств будут установлены для действия если вызвать метод #setActionPropertiesValues

setActionParametersValues

void setActionParametersValues(java.lang.Object action)
                               throws ActionDescriptorException

Метод устанавливает значения свойств объекта действия.

Throws:

ActionDescriptorException

See Also:

#addActionPropertyValue(ActionParameterValue)