JarCasting
JarCasting JarCasting

ColorConverters

Convert Vaadin ColorPicker colors to different CSS notations and back

License

License
Categories

Categories

Vaadin User Interface Web Frameworks
GroupId

GroupId

eu.maxschuster
ArtifactId

ArtifactId

vaadin-colorconverters
Last Version

Last Version

1.0-beta1
Release Date

Release Date
Type

Type

bundle
Description

Description

ColorConverters
Convert Vaadin ColorPicker colors to different CSS notations and back
Project URL

Project URL

https://github.com/maxschuster/Vaadin-ColorConverters/
Project Organization

Project Organization

Max Schuster
Source Code Management

Source Code Management

https://github.com/maxschuster/Vaadin-ColorConverters.git

Download vaadin-colorconverters

Filename Size
vaadin-colorconverters-1.0-beta1.pom
vaadin-colorconverters-1.0-beta1.zip 123 KB
vaadin-colorconverters-1.0-beta1-sources.jar 15 KB
vaadin-colorconverters-1.0-beta1-javadoc.jar 91 KB
Browse

Dependencies

compile (1)

Group / Artifact Type Version
com.vaadin : vaadin-server jar 8.0.4

provided (1)

Group / Artifact Type Version
com.vaadin : vaadin-client jar 8.0.4

test (1)

Group / Artifact Type Version
junit : junit jar 4.8.1

Project Modules

There are no modules declared in this project.

ColorConverters Add-on for Vaadin 8

ColorConverters is a collection of com.vaadin.shared.ui.colorpicker.Color to String converters for Vaadin 8.

Online demo

Try the add-on demo at https://vaadin.maxschuster.eu/ColorConverters/

Download release

Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to http://vaadin.com/addon/ColorConverters

Building and running demo

git clone https://github.com/maxschuster/Vaadin-ColorConverters.git mvn clean install cd demo mvn jetty:run

To see the demo, navigate to http://localhost:8080/

Development with Eclipse IDE

For further development of this add-on, the following tool-chain is recommended:

  • Eclipse IDE
  • m2e wtp plug-in (install it from Eclipse Marketplace)
  • Vaadin Eclipse plug-in (install it from Eclipse Marketplace)
  • JRebel Eclipse plug-in (install it from Eclipse Marketplace)
  • Chrome browser

Importing project

Choose File > Import... > Existing Maven Projects

Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.

Debugging server-side

If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for ColorConverters-root project.

If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your ColorConverters-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature

To debug project and make code modifications on the fly in the server-side, right-click the ColorConverters-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/ColorConverters-demo/ to see the application.

Debugging client-side

Debugging client side code in the ColorConverters-demo project:

  • run "mvn vaadin:run-codeserver" on a separate console while the application is running
  • activate Super Dev Mode in the debug window of the application or by adding ?superdevmode to the URL
  • You can access Java-sources and set breakpoints inside Chrome if you enable source maps from inspector settings.

Release notes

Version 1.0-beta

  • Initial version

Roadmap

This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases. That said, the following features are planned for upcoming releases:

  • ...
  • ...

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

  • Fork this project
  • Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
  • Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
  • Refer to the fixed issue in commit
  • Send a pull request for the original project
  • Comment on the original issue that you have implemented a fix for it

License & Author

Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

ColorConverters is written by Max Schuster

Developer Guide

Getting started

Here is a simple example on how to try out the add-on component:

// Bind a ColorPicker to DTO with a string color field
binder.forField(l.colorPicker)
    .withNullRepresentation(Color.WHITE)
    .withConverter(new ColorToRgbaConverter("Could not convert the string to a color!"))
    .bind(TestDTO::getColor, TestDTO::setColor);

For a more comprehensive example, see vaadin-colorconverters-demo/src/main/java/eu/maxschuster/vaadin/colorconverters/demo/DemoUI.java

Features

Convert Color to String

Convert a Color to RGB (eg. rgb(255,255,255)), RGBA (eg. rgba(255,255,255,1)) or HEX (eg. #ffffff)

Convert String to Color

Convert RGB (eg. rgb(255,255,255)), RGBA (eg. rgba(255,255,255,1)) and HEX (eg. #ffffff) back to a Color

API

ColorConverters JavaDoc is available online at https://www.javadoc.io/doc/eu.maxschuster/vaadin-colorconverters/1.0-beta1

Versions

Version
1.0-beta1