Light

naoghuman / fw-preferences Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 90 KB

The framework `Fw-Preferences` let the developer easily configure varying `Settingsdialogs` for a [JavaFX] application.

License: GNU General Public License v3.0

Java 100.00%

java java-8 javafx javafx-8 javafx-framework preferences options settings netbeans maven

fw-preferences's Introduction

Fw-Preferences

Intention

The framework Fw-Preferences let the developer easily configure varying Settingsdialogs for a JavaFX application.

Content

Examples
- Example 1
JavaDoc
Download
Requirements
Installation
Contribution
License
Autor
Contact

Examples

Example 1

TODO

JavaDoc

TODO

Download

Current version is 0.1.0-PRERELEASE. Main points in this release are:

...
...

Download:

...

An overview about all existings releases can be found here:

Overview from all releases in Fw-Preferences.

Requirements

On your system you need JRE 8 or JDK 8 installed.
The framework fw-preferences-0.1.0-PRERELEASE.jar.

In the library are following libraries registered as dependencies:

The library gson-2.8.5.jar.
The library lib-logger-0.6.0.jar.
- 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 supported by Gluon.
Choose your preferred IDE (e.g. NetBeans, Eclipse or IntelliJ IDEA) for development.
Optional download or clone Lib-Logger.
Open the projects in your IDE and run them.

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 framework Fw-Preferences is licensed under General Public License 3.0.

Autor

The project Fw-Preferences is maintained by me, Peter Rogge. See Contact.

Contact

You can reach me under [email protected].

fw-preferences's People

Contributors

Watchers

fw-preferences's Issues

[doc] Add description to the GitHub project.

[doc] Add description to the GitHub project.

GitHub project.
pom.xml.

[doc] Add folder 'releases' with template.

[doc] Add folder 'releases' with template.

[doc] Create basic concept for the framework.

[doc] Create basic concept for the framework.

Add folder 'concept'
Add template for a concept.
Create basic concept for the framework.

[test] Extends the unittests for the DefaultPreferencesJsonReader with PreferencesMetaData..

[test] Extends the unittests for the DefaultPreferencesJsonReader with PreferencesMetaData..

[test] Extends the unittests for the DefaultPreferencesJsonWriter with PreferencesMetaData..

[test] Extends the unittests for the DefaultPreferencesJsonWriter with PreferencesMetaData..

[doc] Create new concept 'PreferencesConfigurator'.

[doc] Create new concept 'PreferencesConfigurator'.

The PreferencesConfiguratior alloweds the developer to configure per d&d, clicks the wanted 'preferences' in a little application.
The configured preferences will then saved as a JSON file.
The fw-preferences can load this JSON file and returned then a dialog, anchorpane with the preconfigured preferences components.
So I need a way (reflection?, keys?) to configure who the labels will be binded, how the changed values will be communicated.
Thats will also means that the models for the MainSections, SubSection and Settings are annotated with JSON, so the file can loaded immediatly into the Java objects.

[internal] Create new class DefaultPreferencesValidator.

[internal] Create new class DefaultPreferencesValidator.

Add unittests for the validator.
Integrate the validator into all models.

[pom] Tweak the `pom.xml` to fit the necessities from the project.

[pom] Tweak the pom.xml to fit the necessities from the project.

Have a look in 'Lib-I18N'.

[test] Create unittests for DefaultPreferencesJsonWriter.

[test] Create unittests for DefaultPreferencesJsonWriter.

[doc] Extend the concept 'Framework' to v0.2.0.

[doc] Extend the concept 'Framework' to v0.2.0.

What will be done in v0.2.0?

[api] Create the new model class 'PreferencesCategory'.

[api] Create the new model class 'PreferencesCategory'.

[test] Extends the unittests for DefaultPreferencesJsonReader.

[test] Extends the unittests for DefaultPreferencesJsonReader.

Tests with PreferencesGroup(s).

[doc] Update the sections 'Requirements' in the ReadMe.

[doc] Update the sections 'Requirements' in the ReadMe.

Add the dependency to 'gson'.

[fw] Create a basic 'PreferencesConfigurator' application.

[fw] Create a basic 'PreferencesConfigurator' application.

Starts the application in 'test' package.
Implement basic layout -> see concept.

[api] Create new model 'PreferencesSetting'.

[api] Create new model 'PreferencesSetting'.

[api] Create new view for the model 'PreferencesCategory'.

[api] Create new view for the model 'PreferencesCategory'.

The view will be rendered in the PreferencesCategoryArea on the right.

[internal] Create new class DefaultPreferencesJsonReader to read a PreferencesCategory from a JSON file.

[internal] Create new class DefaultPreferencesJsonReader to read a PreferencesCategory from a JSON file.

[fw] Create basic framework structure.

[fw] Create basic framework structure.

[doc] Extend the concept 'PreferencesConfigurator' with the feature 'css'.

[doc] Extend the concept 'PreferencesConfigurator' with the feature 'css'.

Options to added the different parts the framework.

[doc] Update the project description.

Old: The framework Fw-Preferences let the developer easily configure Settingsdialogs in a [JavaFX] application.

New: The framework Fw-Preferences let the developer easily configure varying Settingsdialogs for a [JavaFX] application.

[api] Create the new model class 'PreferencesGroup'.

[api] Create the new model class 'PreferencesGroup'.

title, description

[doc] Write new concept to test the DefaultPreferencesJsonReader, -Writer.

[doc] Write new concept to test the DefaultPreferencesJsonReader, -Writer.

[doc] Add badges from img.shield.io to the ReadMe.md.

[doc] Add badges from img.shield.io to the ReadMe.md.

[api] Create new model 'PreferencesMetaData'.

[api] Create new model 'PreferencesMetaData'.

Contains the stuff for the hole preferences configuration like
- title from dialog
- css for the dialog with parts.
- ...

[internal] Create new class DefaultPreferencesJsonWriter to write a PreferencesCategory to a JSON file.

[internal] Create new class DefaultPreferencesJsonWriter to write a PreferencesCategory to a JSON file.

[api] Rename project to 'fw-settings'.

[api] Rename project to 'fw-settings'.

[test] Extends the unittests for the DefaultPreferencesJsonWriter with PreferencesSettings.

[test] Extends the unittests for the DefaultPreferencesJsonWriter with PreferencesSettings.

[doc] Create new concept 'PreferencesConfigurator.Navigation'.

[doc] Create new concept 'PreferencesConfigurator.Navigation'.

Extract the points for this topic from the concept 'Configuator'.
What are the different in the navigation in a 'normal' PreferencesDialog and in the 'Configurator'?

[doc] Extend the concept 'Framework' to v0.3.0-PRERELEASE.

[doc] Extend the concept 'Framework' to v0.3.0-PRERELEASE.

Models have new name...

[ci] Connect the GitHub project with Travis CI.

[ci] Connect the GitHub project with Travis CI.

[doc] Extend the concept 'Configurator' to v0.3.0-PRERELEASE.

[doc] Extend the concept 'Configurator' to v0.3.0-PRERELEASE.

Add concept for PreferencesMetaData.

[test] Extends the unittests for DefaultPreferencesJsonWriter.

[test] Extends the unittests for DefaultPreferencesJsonWriter.

Tests with PreferencesGroup(s).

[test] Create unittests for DefaultPreferencesJsonReader.

[test] Create unittests for DefaultPreferencesJsonReader.

[doc] Create basic ReadMe structure.

[doc] Create basic ReadMe structure.

[test] Extends the unittests for the DefaultPreferencesJsonReader with PreferencesSettings.

[test] Extends the unittests for the DefaultPreferencesJsonReader with PreferencesSettings.

[doc] Create new concept 'PreferencesConfigurator.Preview(Edit)Mode'.

[doc] Create new concept 'PreferencesConfigurator.Preview(Edit)Mode'.

What are the different between the two modes?
Edit mode in PreferencesConfigurator allowed to configure a hole preferences model.
Preview mode shows the configured preferences model how it would be in an application.

[api] New attribut list from 'PreferencesGroup's into PreferencesCategory.

[api] New attribut list from 'PreferencesGroup's into PreferencesCategory.

[test] Create prototypes to test the 'Search' in the navigation.

[test] Create prototypes to test the 'Search' in the navigation.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.