Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naoghuman/lib-action

Lib-Action is a library for `easy` storing and accessing actions (EventHandler<ActionEvent>) in a JavaFX & Maven desktop application.
https://github.com/naoghuman/lib-action

action actionevent event-handlers java java-8 java-library javafx javafx-8 javafx-library library maven netbeans

Last synced: about 2 months ago
JSON representation

Lib-Action is a library for `easy` storing and accessing actions (EventHandler<ActionEvent>) in a JavaFX & Maven desktop application.

Awesome Lists containing this project

README

        

Lib-Action
===

Intention
---

Lib-Action is a library for `easy` storing and accessing actions ([EventHandler]<[ActionEvent]>)
in a [JavaFX] & [Maven] desktop application.

_Image:_ [UML] Lib-Action
![UML-diagram_Lib-Action_v0.6.0_2018-01-27_04-10.png][UML-diagram_Lib-Action_v0.6.0_2018-01-27_04-10]

> __Hint__
> The `UML` diagram is created with the `Online Modeling Platform` [GenMyModel].

Current `version` is `0.6.0` (01.28.2018 / MM.dd.yyyy).

Content
---

* [Examples](#Examples)
- [How to register, use and access an action](#HoToReUsAnAcAnAc)
- [Usage from the builder TransferDataBuilder](#UsFrTheBuTr)
- [Usage from the interface Registerable](#UsFrThInReAb)
* [Api](#Api)
- [com.github.naoghuman.lib.action.core.ActionHandlerFacade](#AcHaFa)
- [com.github.naoghuman.lib.action.core.ActionHandler](#AcHa)
- [com.github.naoghuman.lib.action.core.TransferDataBuilder](#TrDaBu)
- [com.github.naoghuman.lib.action.core.TransferData](#TrDa)
- [com.github.naoghuman.lib.action.core.Registerable](#ReAb)
* [Download](#Download)
* [Requirements](#Requirements)
* [Installation](#Installation)
* [Documentation](#Documentation)
* [Contribution](#Contribution)
* [License](#License)
* [Autor](#Autor)
* [Contact](#Contact)

Examples
---

### How to register, use and access an action

This example shows how an `action` can be registered with an `actionId` and
how to `trigger` the action and `receive` the event.
```java
public class ApplicationPresenter ... {
// Register an action with the actionId ACTION__APPLICATION__OPEN_EXERCISE
private void registerOnActionOpenExercise() {
LoggerFacade.getDefault().debug(this.getClass(), "Register on action open [Exercise]"); // NOI18N

ActionHandlerFacade.getDefault().register(
ACTION__APPLICATION__OPEN_EXERCISE,
(ActionEvent event) -> {
final TransferData transferData = (TransferData) event.getSource();
final Optional exerciseId = transferData.getLong();
if (exerciseId.isPresent() {
this.onActionOpenExerciseWithId(exerciseId.get());
}
});
}
...
// The above defined action will be executed when a user click on the exericse
// in the navigation.
private void initializeNavigationTabTopics() {
lvFoundedNavigationEntities.setOnMouseClicked(event -> {
if (
event.getClickCount() == 2
&& !lvFoundedNavigationEntities.getSelectionModel().isEmpty()
) {
final NavigationEntity navigationEntity = lvFoundedNavigationEntities.getSelectionModel().getSelectedItem();
final long exerciseId = navigationEntity.getNavigation().getEntityId();

final TransferData transferData = TransferDataBuilder.create()
.actionId(ACTION__APPLICATION__OPEN_EXERCISE)
.setLong(exerciseId)
.build();

ActionHandlerFacade.getDefault().handle(transferData);
}
});
...
}
}

public interface IActionConfiguration {
public static final String ACTION__APPLICATION__OPEN_EXERCISE = "ACTION__APPLICATION__OPEN_EXERCISE"; // NOI18N
...
}
```

### Usage from the builder TransferDataBuilder

The interface [TransferData](#TrDa) is a simple readonly POJO to store optional
values in an [ActionEvent]. An implementation from this interface can be generated
with the builder class [TransferDataBuilder](#TrDaBu).
The following code snippet shows __how__ to use the `TransferDataBuilder` to generate
an instance from the interface `TransferData`:

```java
TransferDataBuilderAllowedSteps() {

/*
The TransferDataBuilder creates an TransferData which can be used to store
additional data in an ActionEvent.
- The attribute 'actionId' is mandory. The attribute is needed to identify
the associated EventHandler which fires the ActionEvent.
- All other attributes are optional. If not set then Optional.empty()
will returned.
- Exception is the method 'disableLogging()' which allowed the developer
to disable the logging from the 'TransferData' during the ActionEvent.
*/
final TransferData transferData = TransferDataBuilder.create()
.actionId("actionId") // mandory (NOT NULL && NOT EMPTY)
.disableLogging() // optional (if used, then the logging is disabled)
.booleanValue(Boolean.FALSE) // optional
.characterValue(Character.MIN_VALUE) // optional
.doubleValue(Double.NaN) // optional
.integerValue(Integer.MIN_VALUE) // optional
.longValue(Long.MIN_VALUE) // optional
.objectValue(new Point()) // optional
.stringValue("value") // optional
.responseActionId("responseActionId") // optional
.build();

/*
Examples from diffrent combinations with the builder.
- The mandory attribute 'actionId' is the first attribute after the
method create().
- The sequence from all optinal attributes aren't fixed.
- If one optional attribute used twice or more then the last usage will
be stored.
*/
TransferDataBuilder.create().actionId("actionId").build();
TransferDataBuilder.create().actionId("actionId").longValue(0L).build();
TransferDataBuilder.create().actionId("actionId").disableLogging().integerValue(1).longValue(0L).build();
TransferDataBuilder.create().actionId("actionId").disableLogging().integerValue(1).booleanValue(Boolean.FALSE).build();

}
```

__Additional informations__
* Design Pattern: [Fluent Interface]
* Design Pattern: [Builder pattern]
* Design Pattern: [Step builder pattern]

### Usage from the interface Registerable

In this example we will see how to use the method `register()` from the
interface [Registerable](#ReAb).
```java
public class ApplicationPresenter implements Registerable ... {
@Override
public void initialize(URL location, ResourceBundle resources) {
// This method will be executed during the initialization from the class
// ApplicationPresenter. So all methods from this method will be executed
// during the initialization.
this.register();
...
}
...
@Override
public void register() {
LoggerFacade.getDefault().debug(this.getClass(), "Register actions in [ApplicationPresenter]"); // NOI18N

this.registerOnActionOpenTerm();
...
}
...
private void registerOnActionOpenTerm() {
LoggerFacade.getDefault().debug(this.getClass(), "Register on action open [Term]"); // NOI18N

ActionHandlerFacade.getDefault().register(
ACTION__APPLICATION__OPEN_TERM,
(ActionEvent event) -> {
final TransferData transferData = (TransferData) event.getSource();
final Optional entityId = transferData.getLong();
if (entityId.isPresent()) {
this.onActionOpenTermWithId(entityId);
}
});
}
}
```

Api
---

### com.github.naoghuman.lib.action.core.ActionHandlerFacade

```java
/**
* The facade {@link com.github.naoghuman.lib.action.core.ActionHandlerFacade}
* provides access to the default {@code Implementation} from the methods in the
* {@code Interface} {@link com.github.naoghuman.lib.action.core.ActionHandler}.
*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.ActionHandler
*/
public final class ActionHandlerFacade implements ActionHandler
```

```java
/**
* Returns a singleton instance from the class {@code ActionHandlerFacade}.
*
* @return a singleton instance from the class {@code ActionHandlerFacade}.
*/
public static final ActionHandlerFacade getDefault()
```

### com.github.naoghuman.lib.action.core.ActionHandler

```java
/**
* With this interface the developer have access to all methods in context from
* store, access and manage {@link javafx.event.EventHandler}s mapped to a specific
* {@code actionId}.
*
* The implementation from this interface {@link com.github.naoghuman.lib.action.internal.DefaultActionHandler}
* can be access over the facade {@link com.github.naoghuman.lib.action.core.ActionHandlerFacade}.
*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.ActionHandlerFacade
* @see com.github.naoghuman.lib.action.internal.DefaultActionHandler
* @see javafx.event.EventHandler
*/
public interface ActionHandler
```

```java
/**
* Fires an {@link javafx.event.ActionEvent} with the associated {@code actionId}.
*


* Hint:

* The {@code actionId} and its associated {@link javafx.event.EventHandler}
* must registered before during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)}.
*
* @param actionId The actionId which allowed access to the assoziated action.
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see javafx.event.ActionEvent
* @see javafx.event.EventHandler
*/
public void handle(final String actionId);
```

```java
/**
* Fires an {@link javafx.event.ActionEvent} with the associated {@code actionId}
* and the given parameter {@code value}.
*


* Internal the parameter {@code data} will be stored in a
* {@link com.github.naoghuman.lib.action.core.TransferData}. The data can
* be access via:

* public void handleOnAction(ActionEvent event) {

*     final TransferData transferData = (TransferData) event.getSource();

*     final long data = transferData.getLong();

*     ⁄ ⁄ do anything with the data

* }
*


* Hint:

* The {@code actionId} and its associated {@link javafx.event.EventHandler}
* must before registered during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)}.
*
* @param actionId The actionId which allowed access to the assoziated action.
* @param value The long parameter which should be stored and transfered by this event.
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see com.github.naoghuman.lib.action.core.TransferData
* @see javafx.event.ActionEvent
* @see javafx.event.EventHandler
*/
public void handle(String actionId, long value);
```

```java
/**
* Fires an {@link javafx.event.ActionEvent} with the associated {@code actionId}
* defined in the {@link com.github.naoghuman.lib.action.core.TransferData}.
*


* The {@link com.github.naoghuman.lib.action.core.TransferData} will be
* stored in the executed {@code ActionEvent} and can reached with the method
* {@code event.getSource(): Object} in the overriden {@code ActionEvent}.
*


* Hint:

* The {@code actionId} and its associated {@link javafx.event.EventHandler}
* must before registered during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)}.
*
* @param transferData A {@code TransferData} which contains the actionId and additional parameters.
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see com.github.naoghuman.lib.action.core.TransferData
* @see javafx.event.ActionEvent
* @see javafx.event.EventHandler
*/
public void handle(final TransferData transferData);
```

```java
/**
* Fires an {@link javafx.event.ActionEvent} for every {@link com.github.naoghuman.lib.action.core.TransferData}
* with the associated {@code actionId} in the specific {@code TransferData}.
*


* The {@link com.github.naoghuman.lib.action.core.TransferData} will be
* stored in the executed {@code ActionEvent} and can reached with the method
* {@code event.getSource(): Object} in the overriden {@code ActionEvent}.
*


* Hint:

* All {@code actionId}s and its associated {@link javafx.event.EventHandler}
* must before registered during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)}.
*
* @param transferDatas A List with {@code TransferData} which contains the actionIds and additional parameters.
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see com.github.naoghuman.lib.action.core.TransferData
* @see javafx.event.ActionEvent
* @see javafx.event.EventHandler
*/
public void handle(final ObservableList transferDatas);
```

```java
/**
* Checks if the specific {@code actionId} is registered.
*
* @param actionId The actionId which should be check if it is exists.
* @return {@code true} if the actionId (with associated EventHandler)
* is registered, otherwise {@code false}.
*/
public boolean isRegistered(final String actionId);
```

```java
/**
* Register an {@link javafx.event.EventHandler} with the specific {@code actionId}.
*
* @param actionId The actionId which allowed access to the associated EventHandler.
* @param eventHandler The assoziated EventHandler which should be registered.
* @return {@code true} if the EventHandler is registered, otherwise {@code false}.
* @see javafx.event.EventHandler
*/
public boolean register(final String actionId, final EventHandler eventHandler);
```

```java
/**
* Removes the {@link javafx.event.EventHandler} with the specific specific
* {@code actionId}.
*
* @param actionId The actionId which should be removed with the associated EventHandler.
* @return {@code true} if the EventHandler is removed, otherwise {@code false}.
* @see javafx.event.EventHandler
*/
public boolean remove(final String actionId);
```

### com.github.naoghuman.lib.action.core.TransferDataBuilder

```java
/**
* With the builder class {@link com.github.naoghuman.lib.action.core.TransferDataBuilder}
* the developer can create an implementation from the {@code Interface}
* {@link com.github.naoghuman.lib.action.core.TransferData}.
*


    *
  • The first attribute {@code actionId} is mandory to identify the associated
    * {@link javafx.event.EventHandler}.

  • *
  • All other attributes are optional, that means skipping them returned
    * {@link java.util.Optional#empty()}

  • *
  • Exception is the method {@code disableLogging()} which allowed the developer
    * to disable the logging from the {@code TransferData} during the {@link javafx.event.ActionEvent}.

  • *

*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.TransferData
* @see com.github.naoghuman.lib.action.core.TransferDataBuilder
* @see java.util.Optional
* @see javafx.event.ActionEvent
* @see javafx.event.EventHandler
*/
public final class TransferDataBuilder
```

```java
/**
* Starts the generation from an implementation from the {@code Interface}
* {@link com.github.naoghuman.lib.action.core.TransferData}.
*
* @return the first step ActionIdStep.
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public static final ActionIdStep create()
```

```java
/**
* First step {@code Interface} {@code ActionIdStep}.
*/
public interface ActionIdStep
```

```java
/**
* Let the developer set the attribute {@code actionId} which is
* associated with an {@link javafx.event.EventHandler}.
*


* This attribute is mandory and must {@code not NULL && not EMPTY}.
*
* @param actionId identifier for the associated EventHandler.
* @return The next {@code Step} {@code Interface}.
* @see javafx.event.EventHandler
*/
public Step actionId(final String actionId);
```

```java
/**
* The {@code Interface} Step contains all optional attributes in the
* {@code Interface} {@link com.github.naoghuman.lib.action.core.TransferData}
* expected the last method {@code build()} in the chain which builds an
* {@code Implementation} from the interface {@code TransferData}.
*
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public interface Step
```

```java
/**
* Let the developer disable the logging from the {@link com.github.naoghuman.lib.action.core.TransferData}
* during the {@link javafx.event.ActionEvent}.
*


* {@code Default} the logging is activated.
*
* @return The next {@code Step} {@code Interface}.
* @see com.github.naoghuman.lib.action.core.TransferData
* @see javafx.event.ActionEvent
*/
public Step disableLogging();
```

```java
/**
* Let the developer define an optional {@link java.lang.Boolean} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Boolean} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Boolean
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step booleanValue(final Boolean value);
```

```java
/**
* Let the developer define an optional {@link java.lang.Character} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Character} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Character
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step characterValue(final Character value);
```

```java
/**
* Let the developer define an optional {@link java.lang.Double} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Double} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Double
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step doubleValue(final Double value);
```

```java
/**
* Let the developer define an optional {@link java.lang.Integer} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Integer} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Integer
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step integerValue(final Integer value);
```

```java
/**
* Let the developer define an optional {@link java.lang.Long} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Long} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Long
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step longValue(final Long value);
```

```java
/**
* Let the developer define an optional {@link java.lang.Object} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code Object} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.Object
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step objectValue(final Object value);
```

```java
/**
* Let the developer define an optional {@link java.lang.String} attribute {@code value}.
*


    *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param value The {@code String} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.String
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step stringValue(final String value);
```

```java
/**
* Let the developer define an optional {@link java.lang.String} attribute {@code responseActionId}.
*


    *
  • If set then the attribute can't be {@code NULL} or {@code EMPTY}.

  • *
  • If this method is used more then ones, then the last usage will be stored for the
    * generation from the {@code Implementation}.

  • *
  • If not set then the {@code Implementation} from {@link com.github.naoghuman.lib.action.core.TransferData}
    * will returned {@link java.util.Optional#empty()}.
    *


*
* @param responseActionId The {@code String} value which should be stored.
* @return The next {@code Step} {@code Interface}.
* @see java.lang.String
* @see java.util.Optional
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public Step responseActionId(final String responseActionId);
```

```java
/**
* Returns an implementation from the {@code Interface} {@link com.github.naoghuman.lib.action.core.TransferData}.
*
* @return an implementation from the {@code Interface} {@code TransferData}.
*
* @see com.github.naoghuman.lib.action.core.TransferData
*/
public TransferData build();
```

### com.github.naoghuman.lib.action.core.TransferData

```java
/**
* The interface {@link com.github.naoghuman.lib.action.core.TransferData} is a
* simple readonly POJO to store optional values in an {@link javafx.event.ActionEvent}.
* An implementation from this interface can be generated with the builder class
* {@link com.github.naoghuman.lib.action.core.TransferDataBuilder}.

* All optional attributes if not set will returned {@link java.util.Optional#empty()}.
*


* For additional information how to use the {@code TransferDataBuilder}
* plz see 'TODO add link to example in readme'.
*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.TransferDataBuilder
* @see java.util.Optional
* @see javafx.event.ActionEvent
*/
public interface TransferData
```

```java
/**
* Get the stored {@link java.lang.String} {@code actionId}.
*
* @return The {@code actionId}.
* @see java.lang.String
*/
public String getActionId();
```

```java
/**
* Get a stored {@link java.lang.Boolean} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Boolean> or Optional.empty().
* @see java.lang.Boolean
* @see java.util.Optional
*/
public Optional getBoolean();
```

```java
/**
* Get a stored {@link java.lang.Character} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Character> or Optional.empty().
* @see java.lang.Character
* @see java.util.Optional
*/
public Optional getCharacter();
```

```java
/**
* Get the stored {@link java.lang.Double} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Double> or Optional.empty().
* @see java.lang.Double
* @see java.util.Optional
*/
public Optional getDouble();
```

```java
/**
* Get the stored {@link java.lang.Integer} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Integer> or Optional.empty().
* @see java.lang.Integer
* @see java.util.Optional
*/
public Optional getInteger();
```

```java
/**
* Get the stored {@link java.lang.Long} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Long> or Optional.empty().
* @see java.lang.Long
* @see java.util.Optional
*/
public Optional getLong();
```

```java
/**
* Get the stored {@link java.lang.Object} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<Object> or Optional.empty().
* @see java.lang.Object
* @see java.util.Optional
*/
public Optional getObject();
```

```java
/**
* Get the stored {@link java.lang.String} {@code value} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<String> or Optional.empty().
* @see java.lang.String
* @see java.util.Optional
*/
public Optional getString();
```

```java
/**
* Get the stored {@link java.lang.String} {@code responseActionId} as an {@link java.util.Optional}.
*
* @return The stored value as an Optional<String> or Optional.empty().
* @see java.lang.String
* @see java.util.Optional
*/
public Optional getResponseActionId();
```

```java
/**
* This flag allowed the developer to verify if the logging from the
* {@link com.github.naoghuman.lib.action.core.TransferData} during the
* {@link javafx.event.ActionEvent} is disabled or not.
*


* {@code Default} the logging is enabled.
*
* @return {@code TRUE} if the logging from the {@code TransferData} disabled
* during the handling from the {@code ActionEvent} otherwise {@code FALSE}.
* @see javafx.event.ActionEvent
*/
public boolean isLoggingDisabled();
```

### com.github.naoghuman.lib.action.core.Registerable

```java
/**
* With this interface the developer have an {@code official} method to register all methods in
* the implementing classes which will {@code register} {@link javafx.event.ActionEvent}s during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler) }
* with an specific {@code actionId}.
*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see javafx.event.ActionEvent
*/
public interface Registerable
```

```java
/**
* Implementing this method alloweds the developer to {@code register} all methods in the
* implementing class which will {@code register} {@link javafx.event.ActionEvent}s during the method
* {@link com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler) }.
*
* @author Naoghuman
* @see com.github.naoghuman.lib.action.core.ActionHandler#register(java.lang.String, javafx.event.EventHandler)
* @see javafx.event.ActionEvent
*/
public void register();
```

Download
---

Current `version` is `0.6.0`. Main points in this release are:
* This is a minor update.
* Add for all default implementations and builders JUnitTests.
* Remove the deprecated content.

**Maven coordinates**
In context from a [Maven] project you can use following maven coordinates:
```xml


com.github.naoghuman
lib-action
0.6.0


com.github.naoghuman
lib-logger
0.6.0

```

Download:
* [Release v6.0 (01.28.2018 / MM.dd.yyyy)]

An overview about all existings releases can be found here:
* [Overview from all releases in Lib-Action]

Requirements
---

* On your system you need [JRE 8] or [JDK 8] installed.
* The library [lib-action-0.6.0.jar](#Installation).

In the library are following libraries registered as dependencies:
* The library [lib-logger-0.6.0.jar](#Installation).
* Included in `Lib-Logger` is the library [log4j-api-2.10.0.jar].
* Included is `Lib-Logger` is the library [log4j-core-2.10.0.jar].

Installation
---

##### Install the project in your preferred IDE

* If not installed download the [JRE 8] or the [JDK 8].
- Optional: To work better with [FXML] files in a [JavaFX] application
download the [JavaFX Scene Builder] under 'Additional Resources'.
* Choose your preferred IDE (e.g. [NetBeans], [Eclipse] or [IntelliJ IDEA]) for development.
* Download or clone [Lib-Action].
* Download or clone [Lib-Logger].
* Open the projects in your IDE and run them.

Documentation
---

* In section [Api](#Api) you can see the main point(s) to access the functionality
in this library.
* For additional information see the [JavaDoc] in the library itself.

Contribution
---

* If you find a `Bug` I will be glad if you could report an [Issue].
* If you want to contribute to the project plz fork the project and do a [Pull Request].

License
---

The project `Lib-Action` is licensed under [General Public License 3.0].

Autor
---

The project `Lib-Action` is maintained by me, Peter Rogge. See [Contact](#Contact).

Contact
---

You can reach me under .

[//]: # (Images)
[UML-diagram_Lib-Action_v0.6.0_2018-01-27_04-10]:https://user-images.githubusercontent.com/8161815/35468137-610bfce6-0318-11e8-891a-7c69cb1905a3.png

[//]: # (Links)
[ActionEvent]:http://docs.oracle.com/javase/8/javafx/api/javafx/event/ActionEvent.html
[Builder pattern]:https://en.wikipedia.org/wiki/Builder_pattern
[Eclipse]:https://www.eclipse.org/
[EventHandler]:http://docs.oracle.com/javase/8/javafx/api/javafx/event/EventHandler.html
[Fluent Interface]:https://www.martinfowler.com/bliki/FluentInterface.html
[FXML]:http://docs.oracle.com/javafx/2/fxml_get_started/jfxpub-fxml_get_started.htm
[General Public License 3.0]:http://www.gnu.org/licenses/gpl-3.0.en.html
[GenMyModel]:https://www.genmymodel.com/
[IntelliJ IDEA]:http://www.jetbrains.com/idea/
[Issue]:https://github.com/Naoghuman/lib-action/issues
[JavaDoc]:http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
[JavaFX]:http://docs.oracle.com/javase/8/javase-clienttechnologies.htm
[JavaFX Scene Builder]:http://www.oracle.com/technetwork/java/javase/downloads/index.html
[JDK 8]:http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
[JRE 8]:http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
[Lib-Action]:https://github.com/Naoghuman/lib-action
[Lib-Logger]:https://github.com/Naoghuman/lib-logger
[log4j-api-2.10.0.jar]:https://logging.apache.org/log4j/2.0/log4j-web/dependencies.html
[log4j-core-2.10.0.jar]:https://logging.apache.org/log4j/2.0/log4j-web/dependencies.html
[Maven]:http://maven.apache.org/
[NetBeans]:https://netbeans.org/
[Overview from all releases in Lib-Action]:https://github.com/Naoghuman/lib-action/releases
[Pull Request]:https://help.github.com/articles/using-pull-requests
[Release v6.0 (01.28.2018 / MM.dd.yyyy)]:https://github.com/Naoghuman/lib-action/releases/tag/v0.6.0
[Step builder pattern]:http://www.svlada.com/step-builder-pattern/
[UML]:https://en.wikipedia.org/wiki/Unified_Modeling_Language