BasicAction (gui.swing 0.2.2 API)

java.lang.Object
- javax.swing.AbstractAction
- - xyz.cofe.gui.swing.BasicAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, GetTarget

Direct Known Subclasses:

CloseableTabHeader.CloseAction, MenuScriptAction, MethodCallAction
```
public class BasicAction
extends AbstractAction
implements GetTarget
```
Базовый класс действия

Author:

Kamnev Georgiy nt.gocha@gmail.com

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BasicAction.AcceleratorBuilder` Создание комбинации клавиш
`class`	`BasicAction.BasicAcceleratorBuilder` Создание комбинации клавиш
`static interface`	`BasicAction.Desc` Информация о действии
`static class`	`BasicAction.Filter` Функции фильтрации

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCELERATOR_PROP`
`static int`	`ACCELERATOR_PROPERTY`
`static String`	`ACTION_COMMAND_PROP`
`static int`	`ACTIONCOMMAND_PROPERTY`
`protected ActionListener`	`actionListener` Подписчик на action
`static String`	`ACTIONLISTENER_PROP`
`static int`	`ACTIONLISTENER_PROPERTY`
`static int`	`ALL` Перечисляет все свойства
`static int`	`DEF` Перечисляет все свойства по умолчанию
`static int`	`DIPLAYMNEMONICINDEX_PROPERTY`
`static String`	`DISPLAY_MNEMONIC_INDEX_PROP`
`static int`	`KEYBOARDSHORTCUTS_PROPERTY`
`static String`	`LARGE_ICON_PROP`
`static int`	`LARGEICON_PROPERTY`
`static String`	`LONG_DESCRIPTION_PROP`
`static int`	`LONGDESCRIPTION_PROPERTY`
`static String`	`MNEMONIC_PROP`
`static int`	`MNEMONIC_PROPERTY`
`static String`	`NAME_PROP`
`static int`	`NAME_PROPERTY`
`static String`	`SELECTED_PROP` Имя свойства "selected"
`static int`	`SELECTED_PROPERTY`
`static String`	`SHORT_DESCRIPTION_PROP`
`static int`	`SHORTDESCRIPTION_PROPERTY`
`static String`	`SMALL_ICON_PROP`
`static int`	`SMALLICON_PROPERTY`
`static int`	`TARGET_PROPERTY`

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description
`BasicAction()` Конструктор по умолчанию
`BasicAction(Action action)` Конструктор копирования
`BasicAction(Action action, int copyProperties)` Конструктор копирования
`BasicAction(String name)` Конструктор
`BasicAction(String name, ActionListener listener)` Конструктор
`BasicAction(String name, Runnable listener)` Конструктор

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasicAction.AcceleratorBuilder`	`accelerator()` Создание комбинации клавиш
`BasicAction`	`accelerator(KeyStroke newAcceleratorKeyStroke)`
`BasicAction`	`actionCommand(String action)`
`BasicAction`	`actionListener(ActionListener listener)`
`BasicAction`	`actionListener(Runnable listener)`
`void`	`actionPerformed(ActionEvent e)`
`BasicAction`	`addShortcut(KeyboardShortcut ks)`
`static void`	`apply(Action act, BasicAction.Desc desc)` Применяет указанную информацию к "действию"
`void`	`copyTo(Action action, int copyProperties)` Копируемые значения
`BasicAction`	`displayedMnemonicIndex(Integer index)` Указывает индекс мнемноники
`KeyStroke`	`getAccelerator()`
`static KeyStroke`	`getAccelerator(Action a)`
`String`	`getActionCommand()`
`static String`	`getActionCommand(Action act)`
`ActionListener`	`getActionListener()` Указывает ActionListener
`Integer`	`getDisplayedMnemonicIndex()` Возвращает индекс мнемноники
`static Integer`	`getDisplayedMnemonicIndex(Action act)` Возвращает индекс мнемноники
`xyz.cofe.collection.set.EventSet<KeyboardShortcut>`	`getKeyboardShortcuts()`
`Icon`	`getLargeIcon()` Возвращает (большую) иконку действия
`static Icon`	`getLargeIcon(Action act)` Возвращает (большую) иконку действия
`String`	`getLongDescription()` Возвращает полное описание
`static String`	`getLongDescription(Action act)` Возвращает полное описание
`Integer`	`getMnemonic()`
`static Integer`	`getMnemonic(Action act)`
`String`	`getName()` Возвращает имя/текст действия
`static String`	`getName(Action act)` Возвращает имя/текст действия
`String`	`getShortDescription()` Возвращает краткое описание
`static String`	`getShortDescription(Action act)` Возвращает краткое описание
`Icon`	`getSmallIcon()` Возвращает иконку (малую) действия
`static Icon`	`getSmallIcon(Action act)` Возвращает иконку (малую) действия
`Class`	`getTarget()` Указыает класс GUI компонента или его объекта, для которого применяется Action
`boolean`	`isSelected()` Возвращает выделен/выбран ли объект UI пользователем
`BasicAction`	`largeIcon(Icon i)` Указывает (большую) иконку действия
`BasicAction`	`longDescription(String text)` Указывает полное описание
`BasicAction`	`mnemonic(Integer mnemonic)`
`BasicAction`	`name(String text)` Указывает имя/текст действия
`void`	`putValue(String key, Object newValue)`
`static void`	`setAccelerator(Action act, KeyStroke newAcceleratorKeyStroke)`
`void`	`setAccelerator(KeyStroke newAcceleratorKeyStroke)`
`static void`	`setActionCommand(Action act, String newValue)`
`void`	`setActionCommand(String action)`
`void`	`setActionListener(ActionListener actionListener)` Указывает ActionListener
`static void`	`setDisplayedMnemonicIndex(Action act, Integer newValue)` Указывает индекс мнемноники
`void`	`setDisplayedMnemonicIndex(Integer index)` Указывает индекс мнемноники
`static void`	`setLargeIcon(Action act, Icon newIcon)` Указывает (большую) иконку действия
`void`	`setLargeIcon(Icon i)` Указывает (большую) иконку действия
`static void`	`setLongDescription(Action act, String newValue)` Указывает полное описание
`void`	`setLongDescription(String text)` Указывает полное описание
`static void`	`setMnemonic(Action act, Integer newValue)`
`void`	`setMnemonic(Integer mnemonic)`
`static void`	`setName(Action act, String name)` Указывает имя/текст действия
`void`	`setName(String text)` Указывает имя/текст действия
`void`	`setSelected(boolean selected)` Указывает выделен/выбран ли объект UI пользователем
`static void`	`setShortDescription(Action act, String newValue)` Указывает краткое описание
`void`	`setShortDescription(String text)` Указывает краткое описание
`static void`	`setSmallIcon(Action act, Icon newIcon)` Указывает иконку (малую) действия
`void`	`setSmallIcon(Icon newIcon)` Указывает иконку (малую) действия
`void`	`setTarget(Class target)`
`BasicAction`	`shortDescription(String text)` Указывает краткое описание
`BasicAction`	`smallIcon(Icon newIcon)` Указывает иконку (малую) действия

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SELECTED_PROPERTY
```
public static final int SELECTED_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SELECTED_PROP
```
public static final String SELECTED_PROP
```
    Имя свойства "selected"
    
    See Also:
    
    Constant Field Values
  - NAME_PROPERTY
```
public static final int NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - NAME_PROP
```
public static final String NAME_PROP
```
    See Also:
    
    Constant Field Values
  - SMALLICON_PROPERTY
```
public static final int SMALLICON_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SMALL_ICON_PROP
```
public static final String SMALL_ICON_PROP
```
    See Also:
    
    Constant Field Values
  - LARGEICON_PROPERTY
```
public static final int LARGEICON_PROPERTY
```
    See Also:
    
    Constant Field Values
  - LARGE_ICON_PROP
```
public static final String LARGE_ICON_PROP
```
    See Also:
    
    Constant Field Values
  - ACCELERATOR_PROPERTY
```
public static final int ACCELERATOR_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ACCELERATOR_PROP
```
public static final String ACCELERATOR_PROP
```
    See Also:
    
    Constant Field Values
  - SHORTDESCRIPTION_PROPERTY
```
public static final int SHORTDESCRIPTION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SHORT_DESCRIPTION_PROP
```
public static final String SHORT_DESCRIPTION_PROP
```
    See Also:
    
    Constant Field Values
  - LONGDESCRIPTION_PROPERTY
```
public static final int LONGDESCRIPTION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - LONG_DESCRIPTION_PROP
```
public static final String LONG_DESCRIPTION_PROP
```
    See Also:
    
    Constant Field Values
  - DIPLAYMNEMONICINDEX_PROPERTY
```
public static final int DIPLAYMNEMONICINDEX_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DISPLAY_MNEMONIC_INDEX_PROP
```
public static final String DISPLAY_MNEMONIC_INDEX_PROP
```
    See Also:
    
    Constant Field Values
  - ACTIONCOMMAND_PROPERTY
```
public static final int ACTIONCOMMAND_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ACTION_COMMAND_PROP
```
public static final String ACTION_COMMAND_PROP
```
    See Also:
    
    Constant Field Values
  - MNEMONIC_PROPERTY
```
public static final int MNEMONIC_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MNEMONIC_PROP
```
public static final String MNEMONIC_PROP
```
    See Also:
    
    Constant Field Values
  - KEYBOARDSHORTCUTS_PROPERTY
```
public static final int KEYBOARDSHORTCUTS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TARGET_PROPERTY
```
public static final int TARGET_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ACTIONLISTENER_PROPERTY
```
public static final int ACTIONLISTENER_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ACTIONLISTENER_PROP
```
public static final String ACTIONLISTENER_PROP
```
    See Also:
    
    Constant Field Values
  - actionListener
```
protected ActionListener actionListener
```
    Подписчик на action
  - ALL
```
public static final int ALL
```
    Перечисляет все свойства
    
    See Also:
    
    SELECTED_PROPERTY, NAME_PROPERTY, SMALLICON_PROPERTY, LARGEICON_PROPERTY, ACCELERATOR_PROPERTY, SHORTDESCRIPTION_PROPERTY, LONGDESCRIPTION_PROPERTY, DIPLAYMNEMONICINDEX_PROPERTY, ACTIONCOMMAND_PROPERTY, MNEMONIC_PROPERTY, KEYBOARDSHORTCUTS_PROPERTY, TARGET_PROPERTY, ACTIONLISTENER_PROPERTY, Constant Field Values
  - DEF
```
public static final int DEF
```
    Перечисляет все свойства по умолчанию
    
    See Also:
    
    NAME_PROPERTY, SMALLICON_PROPERTY, LARGEICON_PROPERTY, ACCELERATOR_PROPERTY, SHORTDESCRIPTION_PROPERTY, LONGDESCRIPTION_PROPERTY, DIPLAYMNEMONICINDEX_PROPERTY, MNEMONIC_PROPERTY, KEYBOARDSHORTCUTS_PROPERTY, Constant Field Values
- Constructor Detail
  - BasicAction
```
public BasicAction()
```
    Конструктор по умолчанию
  - BasicAction
```
public BasicAction(String name)
```
    Конструктор
    
    Parameters:
    
    name - Имя (отображаемый текст)
  - BasicAction
```
public BasicAction(String name,
                   ActionListener listener)
```
    Конструктор
    
    Parameters:
    
    name - Имя (отображаемый текст)
    
    listener - Обработчик
  - BasicAction
```
public BasicAction(String name,
                   Runnable listener)
```
    Конструктор
    
    Parameters:
    
    name - Имя (отображаемый текст)
    
    listener - Обработчик
  - BasicAction
```
public BasicAction(Action action)
```
    Конструктор копирования
    
    Parameters:
    
    action - Образец
  - BasicAction
```
public BasicAction(Action action,
                   int copyProperties)
```
    Конструктор копирования
    
    Parameters:
    
    action - Образец
    
    copyProperties - Копируемые значения
- Method Detail
  - apply
```
public static void apply(Action act,
                         BasicAction.Desc desc)
```
    Применяет указанную информацию к "действию"
    
    Parameters:
    
    act - Действие
    
    desc - Информаия
  - isSelected
```
public boolean isSelected()
```
    Возвращает выделен/выбран ли объект UI пользователем
    
    Returns:
    
    true объект выделен
  - setSelected
```
public void setSelected(boolean selected)
```
    Указывает выделен/выбран ли объект UI пользователем
    
    Parameters:
    
    selected - true объект выделен/выбран
  - getName
```
public String getName()
```
    Возвращает имя/текст действия
    
    Returns:
    
    имя/текст действия
  - getName
```
public static String getName(Action act)
```
    Возвращает имя/текст действия
    
    Parameters:
    
    act - действие
    
    Returns:
    
    имя/текст
  - setName
```
public void setName(String text)
```
    Указывает имя/текст действия
    
    Parameters:
    
    text - текст
  - setName
```
public static void setName(Action act,
                           String name)
```
    Указывает имя/текст действия
    
    Parameters:
    
    act - действие
    
    name - имя/текст
  - name
```
public BasicAction name(String text)
```
    Указывает имя/текст действия
    
    Parameters:
    
    text - имя/текст
    
    Returns:
    
    self ссылка
  - getSmallIcon
```
public Icon getSmallIcon()
```
    Возвращает иконку (малую) действия
    
    Returns:
    
    иконка
  - getSmallIcon
```
public static Icon getSmallIcon(Action act)
```
    Возвращает иконку (малую) действия
    
    Parameters:
    
    act - действие
    
    Returns:
    
    иконка
  - setSmallIcon
```
public void setSmallIcon(Icon newIcon)
```
    Указывает иконку (малую) действия
    
    Parameters:
    
    newIcon - иконка
  - smallIcon
```
public BasicAction smallIcon(Icon newIcon)
```
    Указывает иконку (малую) действия
    
    Parameters:
    
    newIcon - иконка
    
    Returns:
    
    self ссылка
  - setSmallIcon
```
public static void setSmallIcon(Action act,
                                Icon newIcon)
```
    Указывает иконку (малую) действия
    
    Parameters:
    
    act - действие
    
    newIcon - иконка
  - getLargeIcon
```
public Icon getLargeIcon()
```
    Возвращает (большую) иконку действия
    
    Returns:
    
    иконка
  - getLargeIcon
```
public static Icon getLargeIcon(Action act)
```
    Возвращает (большую) иконку действия
    
    Parameters:
    
    act - действие
    
    Returns:
    
    иконка
  - setLargeIcon
```
public void setLargeIcon(Icon i)
```
    Указывает (большую) иконку действия
    
    Parameters:
    
    i - иконка
  - largeIcon
```
public BasicAction largeIcon(Icon i)
```
    Указывает (большую) иконку действия
    
    Parameters:
    
    i - иконка
    
    Returns:
    
    self ссылка
  - setLargeIcon
```
public static void setLargeIcon(Action act,
                                Icon newIcon)
```
    Указывает (большую) иконку действия
    
    Parameters:
    
    act - действие
    
    newIcon - иконка
  - getAccelerator
```
public static KeyStroke getAccelerator(Action a)
```
  - getAccelerator
```
public KeyStroke getAccelerator()
```
  - setAccelerator
```
public void setAccelerator(KeyStroke newAcceleratorKeyStroke)
```
  - accelerator
```
public BasicAction accelerator(KeyStroke newAcceleratorKeyStroke)
```
  - setAccelerator
```
public static void setAccelerator(Action act,
                                  KeyStroke newAcceleratorKeyStroke)
```
  - accelerator
```
public BasicAction.AcceleratorBuilder accelerator()
```
    Создание комбинации клавиш
    
    Returns:
    
    строитель комбинации
  - getShortDescription
```
public String getShortDescription()
```
    Возвращает краткое описание
    
    Returns:
    
    краткое описание
  - setShortDescription
```
public void setShortDescription(String text)
```
    Указывает краткое описание
    
    Parameters:
    
    text - краткое описание
  - shortDescription
```
public BasicAction shortDescription(String text)
```
    Указывает краткое описание
    
    Parameters:
    
    text - краткое описание
    
    Returns:
    
    self ссылка
  - getShortDescription
```
public static String getShortDescription(Action act)
```
    Возвращает краткое описание
    
    Parameters:
    
    act - действие
    
    Returns:
    
    краткое описание
  - setShortDescription
```
public static void setShortDescription(Action act,
                                       String newValue)
```
    Указывает краткое описание
    
    Parameters:
    
    act - действие
    
    newValue - краткое описание
  - getLongDescription
```
public String getLongDescription()
```
    Возвращает полное описание
    
    Returns:
    
    полное описание
  - setLongDescription
```
public void setLongDescription(String text)
```
    Указывает полное описание
    
    Parameters:
    
    text - полное описание
  - longDescription
```
public BasicAction longDescription(String text)
```
    Указывает полное описание
    
    Parameters:
    
    text - полное описание
    
    Returns:
    
    self ссылка
  - getLongDescription
```
public static String getLongDescription(Action act)
```
    Возвращает полное описание
    
    Parameters:
    
    act - действие
    
    Returns:
    
    полное описание
  - setLongDescription
```
public static void setLongDescription(Action act,
                                      String newValue)
```
    Указывает полное описание
    
    Parameters:
    
    act - действие
    
    newValue - полное описание
  - getDisplayedMnemonicIndex
```
public Integer getDisplayedMnemonicIndex()
```
    Возвращает индекс мнемноники
    
    Returns:
    
    индекс мнемноники
  - setDisplayedMnemonicIndex
```
public void setDisplayedMnemonicIndex(Integer index)
```
    Указывает индекс мнемноники
    
    Parameters:
    
    index - индекс мнемноники
  - displayedMnemonicIndex
```
public BasicAction displayedMnemonicIndex(Integer index)
```
    Указывает индекс мнемноники
    
    Parameters:
    
    index - индекс мнемноники
    
    Returns:
    
    self ссылка
  - getDisplayedMnemonicIndex
```
public static Integer getDisplayedMnemonicIndex(Action act)
```
    Возвращает индекс мнемноники
    
    Parameters:
    
    act - действие
    
    Returns:
    
    индекс
  - setDisplayedMnemonicIndex
```
public static void setDisplayedMnemonicIndex(Action act,
                                             Integer newValue)
```
    Указывает индекс мнемноники
    
    Parameters:
    
    act - действие
    
    newValue - индекс мнемноники
  - getActionCommand
```
public String getActionCommand()
```
  - setActionCommand
```
public void setActionCommand(String action)
```
  - actionCommand
```
public BasicAction actionCommand(String action)
```
  - getActionCommand
```
public static String getActionCommand(Action act)
```
  - setActionCommand
```
public static void setActionCommand(Action act,
                                    String newValue)
```
  - getMnemonic
```
public Integer getMnemonic()
```
  - setMnemonic
```
public void setMnemonic(Integer mnemonic)
```
  - mnemonic
```
public BasicAction mnemonic(Integer mnemonic)
```
  - getMnemonic
```
public static Integer getMnemonic(Action act)
```
  - setMnemonic
```
public static void setMnemonic(Action act,
                               Integer newValue)
```
  - getKeyboardShortcuts
```
public xyz.cofe.collection.set.EventSet<KeyboardShortcut> getKeyboardShortcuts()
```
  - addShortcut
```
public BasicAction addShortcut(KeyboardShortcut ks)
```
  - getTarget
```
public Class getTarget()
```
    Description copied from interface: GetTarget
    
    Указыает класс GUI компонента или его объекта, для которого применяется Action
    
    Specified by:
    
    getTarget in interface GetTarget
    
    Returns:
    
    класс GUI
  - setTarget
```
public void setTarget(Class target)
```
  - getActionListener
```
public ActionListener getActionListener()
```
    Указывает ActionListener
    
    Returns:
    
    actionListener
  - setActionListener
```
public void setActionListener(ActionListener actionListener)
```
    Указывает ActionListener
    
    Parameters:
    
    actionListener - Подписчик
  - actionListener
```
public BasicAction actionListener(ActionListener listener)
```
  - actionListener
```
public BasicAction actionListener(Runnable listener)
```
  - copyTo
```
public void copyTo(Action action,
                   int copyProperties)
```
    Копируемые значения
    
    Parameters:
    
    action - Действие которому присваиваются свойства.
    
    copyProperties - Комбинация OR копируемых свойств, например NAME_PROPERTY | SMALLICON_PROPERTY.
  - putValue
```
public void putValue(String key,
                     Object newValue)
```
    Specified by:
    
    putValue in interface Action
    
    Overrides:
    
    putValue in class AbstractAction
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener

Class BasicAction

Nested Class Summary

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

SELECTED_PROPERTY

SELECTED_PROP

NAME_PROPERTY

NAME_PROP

SMALLICON_PROPERTY

SMALL_ICON_PROP

LARGEICON_PROPERTY

LARGE_ICON_PROP

ACCELERATOR_PROPERTY

ACCELERATOR_PROP

SHORTDESCRIPTION_PROPERTY

SHORT_DESCRIPTION_PROP

LONGDESCRIPTION_PROPERTY

LONG_DESCRIPTION_PROP

DIPLAYMNEMONICINDEX_PROPERTY

DISPLAY_MNEMONIC_INDEX_PROP

ACTIONCOMMAND_PROPERTY

ACTION_COMMAND_PROP

MNEMONIC_PROPERTY

MNEMONIC_PROP

KEYBOARDSHORTCUTS_PROPERTY

TARGET_PROPERTY

ACTIONLISTENER_PROPERTY

ACTIONLISTENER_PROP

actionListener

ALL

DEF

Constructor Detail

BasicAction

BasicAction

BasicAction

BasicAction

BasicAction

BasicAction

Method Detail

apply

isSelected

setSelected

getName

getName

setName

setName

name

getSmallIcon

getSmallIcon

setSmallIcon

smallIcon

setSmallIcon

getLargeIcon

getLargeIcon

setLargeIcon

largeIcon

setLargeIcon

getAccelerator

getAccelerator

setAccelerator

accelerator

setAccelerator

accelerator

getShortDescription

setShortDescription

shortDescription

getShortDescription

setShortDescription

getLongDescription

setLongDescription

longDescription

getLongDescription

setLongDescription

getDisplayedMnemonicIndex