Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sshtools/icon-generator
A simple library for generating Java2D (Swing/AWT) and JavaFX icons in Java, with SWT support in an add-on.
https://github.com/sshtools/icon-generator
awt fontawesome generator icons java javafx swing swt
Last synced: 3 months ago
JSON representation
A simple library for generating Java2D (Swing/AWT) and JavaFX icons in Java, with SWT support in an add-on.
- Host: GitHub
- URL: https://github.com/sshtools/icon-generator
- Owner: sshtools
- License: apache-2.0
- Created: 2015-11-11T10:36:40.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T18:42:01.000Z (10 months ago)
- Last Synced: 2024-09-28T12:04:45.086Z (4 months ago)
- Topics: awt, fontawesome, generator, icons, java, javafx, swing, swt
- Language: Java
- Homepage:
- Size: 332 KB
- Stars: 20
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# icon-generator
A simple library for generating Java2D (Swing/AWT), JavaFX and SWT icons in Java.
icon-generator generates icons images automatically from text or icons with customisable shapes, colour
and styles.
## Configuring your project
The library is available in Maven Central, so configure your project according to the
build system you use.
As from version 1.2, *icon-generator* requires Java 9 or higher (due to modularity requirements). If you
want to use this library with Java 8 or earlier, then you will have to continue to use version
**1.0.3**. I may consider future 1.0.x releases if anyone needs them.
Choose the appropriate module for the toolkit you wish to use.
You may include multiple toolkits if you wish :-
### Swing
```xml
com.sshtools
icon-generator-swing
1.3.0
```
### JavaFX
```xml
com.sshtools
icon-generator-javafx
1.3.0
```
### SWT
```xml
com.sshtools
icon-generator-swt
1.3.0
```
## Configuring the Icon
For this, you use [IconBuilder](src/main/java/com/sshtools/icongenerator/IconBuilder.java).
### Create The Builder
```java
IconBuilder builder = new IconBuilder();
```
### Sizes
```java
builder.width(64);
builder.height(64);
```
### Text Colours
```java
builder.textColor(0xff0000); // red
// or
build.textColor(IconBuilder.AUTO_TEXT_COLOR);
// or
build.textColor(IconBuilder.RANDOM_TEXT_COLOR);
// or
build.textColor(IconBuilder.AUTO_TEXT_COLOR_WHITE);
// or
build.textColor(IconBuilder.AUTO_TEXT_COLOR_BLACK);
// and the background colour
builder.color(0x00ff00); // green
// or
builder.color(IconBuilder.AUTO_COLOR); // based on text / icon
// or
builder.color(IconBuilder.RANDOM_COLOR);
```
### Shape
```java
builder.autoShape();
// or
builder.rect(); // rectangle
// or
builder.round(); // round
// or
builder.rectRound(8); // rounded rectangle with 8px radius
```
### Text And Fonts
```java
builder.text("AB");
// or a full word and a processing option
builder.text("Actually Brilliant");
builder.textCase(TextCase.UPPER);
builder.textContext(TextContext.INITIALS);
// Font
builder.font("Monospaced");
builder.fontSize(12);
builder.bold(true);
```
### Font Awesome Icon
```java
builder.icon(AwesomeIcon.ADDRESS_BOOK);
// or
builder.awesomeIconMode(AwesomeIconMode.AUTO_TEXT);
// or
builder.awesomeIconMode(AwesomeIconMode.AUTO_MATCH);
```
## Generate The Icon
Now you can use the IconBuilder.build() for the toolkit you are using. You must
provide the class of the concrete icon to create, depending on the toolkit. The
following are supported :-
| Class | Module | Description |
| --- | --- | --- |
| java.awt.BufferedImage | icon-generator-swing | A Swing buffered image. |
| java.awt.Image | icon-generator-swing | A Swing buffered image. |
| javax.swing.Icon | icon-generator-swing | A Swing icon. |
| org.eclipse.swt.graphics.Image | icon-generator-swt | An SWT image. |
| javafx.scene.canvas.Canvas | icon-generator-javafx | A JavaFX canvas. |
### Generate an ImageIcon for use in Swing
```
JLabel l = new JLabel("A label with an icon");
l.setIcon(builder.build(Icon.class));
```
### Generate a Java2D BufferedImage for use in a servlet
Something like this :-
```java
response.setContentType("image/jpeg");
try(OutputStream out = response.getOutputStream()) {
ImageIO.write(builder.build(BufferedImage.class), "jpg", out);
}
```
## Extending
New generators may be added by implementing [IconGenerator](src/main/java/com/sshtools/icongenerator/IconGenerator.java).
You can then either add the generator to each IconBuilder you create :-
```java
builder.generator(MyIcon.class, new IconGenerator() {
@Override
public Class getIconClass() {
return MyIcon.class;
}
@Override
public boolean isValid() {
/* This can be used to have the generator ignored if some pre-condition is not met,
such as a supporting library not being available */
return true;
}
@Override
public MyIcon generate(IconBuilder builder, Object... args) {
MyIcon myIcon = ..
/** Do stuff to generate a MyIcon given the configuration provided by IconBuilder */
return myIcon;
}
});
```
.. or create a concrete class and add it as a service. Create a classpath resource named *META-INF/services/com.sshtools.icongenerator.IconGenerator* (e.g. src/main/resources/META-INF/services/com.sshtools.icongenerator.IconGenerator) and place the full class name of your IconGenerator implementation inside it.
```
com.mystuff.icongen.MyIconGenerator
```
This will then be automatically loaded whenever you create a new IconBuilder instance, and you can use the *build()*
method as normal :-
```java
IconBuilder builder = new IconBuilder();
// do stuff to create builder ...
MyIcon myIcon = builder.build(MyIcon.class);
```
The *build()* method also can accept additional arguments which are passed on to the generator, if your generator
needs additional configuration.
```java
MyIcon myIcon = builder.build(MyIcon.class, flipX, flipY);
```
.. and then in the generator access the arguments :-
```java
@Override
public MyIcon generate(IconBuilder builder, Object... args) {
boolean flipX = (Boolean)args[0];
boolean flipY = (Boolean)args[1];
MyIcon myIcon = ..
/** Do stuff to generate a MyIcon given the configuration provided by IconBuilder */
return myIcon;
}
```