BasicAction (gui.swing 0.1 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:

gocha

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BasicAction.AcceleratorBuilder`
`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`
`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()`
`ActionListener`	`getActionListener()` Указывает ActionListener
`Integer`	`getDisplayedMnemonicIndex()`
`xyz.cofe.collection.set.EventSet<KeyboardShortcut>`	`getKeyboardShortcuts()`
`Icon`	`getLargeIcon()`
`String`	`getLongDescription()`
`Integer`	`getMnemonic()`
`String`	`getName()`
`String`	`getShortDescription()`
`Icon`	`getSmallIcon()`
`Class`	`getTarget()`
`boolean`	`isSelected()`
`BasicAction`	`largeIcon(Icon i)`
`BasicAction`	`longDescription(String text)`
`BasicAction`	`mnemonic(Integer mnemonic)`
`BasicAction`	`name(String text)`
`void`	`putValue(String key, Object newValue)`
`void`	`setAccelerator(KeyStroke newAcceleratorKeyStroke)`
`void`	`setActionCommand(String action)`
`void`	`setActionListener(ActionListener actionListener)` Указывает ActionListener
`void`	`setDisplayedMnemonicIndex(Integer index)`
`void`	`setLargeIcon(Icon i)`
`void`	`setLongDescription(String text)`
`void`	`setMnemonic(Integer mnemonic)`
`void`	`setName(String text)`
`void`	`setSelected(boolean selected)`
`void`	`setShortDescription(String text)`
`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
```
  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()
```

setSelected

public void setSelected(boolean selected)

getName
```
public String getName()
```

setName
```
public void setName(String text)
```

name
```
public BasicAction name(String text)
```

getSmallIcon
```
public Icon getSmallIcon()
```

setSmallIcon

public void setSmallIcon(Icon newIcon)

smallIcon

public BasicAction smallIcon(Icon newIcon)

getLargeIcon
```
public Icon getLargeIcon()
```

setLargeIcon
```
public void setLargeIcon(Icon i)
```

largeIcon
```
public BasicAction largeIcon(Icon i)
```

getAccelerator

public static KeyStroke getAccelerator(Action a)

getAccelerator
```
public KeyStroke getAccelerator()
```

setAccelerator

public void setAccelerator(KeyStroke newAcceleratorKeyStroke)

accelerator

public BasicAction accelerator(KeyStroke newAcceleratorKeyStroke)

accelerator

public BasicAction.AcceleratorBuilder accelerator()

getShortDescription
```
public String getShortDescription()
```

setShortDescription

public void setShortDescription(String text)

shortDescription

public BasicAction shortDescription(String text)

getLongDescription
```
public String getLongDescription()
```

setLongDescription

public void setLongDescription(String text)

longDescription

public BasicAction longDescription(String text)

getDisplayedMnemonicIndex

public Integer getDisplayedMnemonicIndex()

setDisplayedMnemonicIndex

public void setDisplayedMnemonicIndex(Integer index)

displayedMnemonicIndex

public BasicAction displayedMnemonicIndex(Integer index)

getActionCommand
```
public String getActionCommand()
```

setActionCommand

public void setActionCommand(String action)

actionCommand

public BasicAction actionCommand(String action)

getMnemonic
```
public Integer getMnemonic()
```

setMnemonic

public void setMnemonic(Integer mnemonic)

mnemonic

public BasicAction mnemonic(Integer mnemonic)

getKeyboardShortcuts

public xyz.cofe.collection.set.EventSet<KeyboardShortcut> getKeyboardShortcuts()

addShortcut

public BasicAction addShortcut(KeyboardShortcut ks)

getTarget
```
public Class getTarget()
```
Specified by:

getTarget in interface GetTarget

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

setName

name

getSmallIcon

setSmallIcon

smallIcon

getLargeIcon

setLargeIcon

largeIcon

getAccelerator

getAccelerator

setAccelerator

accelerator

accelerator

getShortDescription

setShortDescription

shortDescription

getLongDescription

setLongDescription

longDescription

getDisplayedMnemonicIndex

setDisplayedMnemonicIndex

displayedMnemonicIndex

getActionCommand

setActionCommand

actionCommand

getMnemonic

setMnemonic

mnemonic

getKeyboardShortcuts

addShortcut

getTarget