JabRefIcon backed by an Ikonli font glyph, rendered as a FontIcon. The font-backed counterpart to SvgIcon. Immutable: withColor and withSize return copies.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	IkonliIcon.IkonliIcons Holds every `Ikon` discovered via the `IkonProvider` service loader.

Field Summary

Modifier and Type	Field and Description
private final @Nullable Color	color
private static final int	DEFAULT_SIZE Ikonli's own default, so an icon that was never given a size renders as it always has.
private final List<Ikon>	icons
private final int	size

Constructor Summary

Access	Constructor and Description
public	IkonliIcon(Ikon... icons)
public	IkonliIcon(List<Ikon> icons)
public	IkonliIcon(Color color, Ikon... icons)
pack-priv	IkonliIcon(Color color, List<Ikon> icons)
private	IkonliIcon(List<Ikon> icons, @Nullable Color color, int size)

Method Summary

Modifier and Type	Method and Description
public static SequencedSet<Ikon>	allIcons()
private FontIcon	buildFontIcon(Ikon ikon)
public JabRefIcon	disabled() Implements org.jabref.gui.icon.JabRefIcon.disabled.
public static Optional<JabRefIcon>	findIcon(String code) Finds the Ikonli icon whose name matches `code` (case-insensitive).
public static Optional<JabRefIcon>	findIconByDescription(String description) Finds the Ikonli icon whose pack-qualified description matches `description` (case-insensitive).
public Node	getGraphicNode() Implements org.jabref.gui.icon.JabRefIcon.getGraphicNode.
public boolean	matches(Node graphicNode) Implements org.jabref.gui.icon.JabRefIcon.matches.
public String	name() Implements org.jabref.gui.icon.JabRefIcon.name.
public JabRefIcon	withColor(Color color) Implements org.jabref.gui.icon.JabRefIcon.withColor.
public JabRefIcon	withSize(int size) Implements org.jabref.gui.icon.JabRefIcon.withSize. Returns a copy of this icon rendered at `size` pixels.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

color	back to summary
private final @Nullable Color color

DEFAULT_SIZE	back to summary
private static final int DEFAULT_SIZE Ikonli's own default, so an icon that was never given a size renders as it always has.

icons	back to summary
private final List<Ikon> icons

size	back to summary
private final int size

Constructor Detail

IkonliIcon	back to summary
public IkonliIcon(Ikon... icons)

IkonliIcon	back to summary
public IkonliIcon(List<Ikon> icons)

IkonliIcon	back to summary
public IkonliIcon(Color color, Ikon... icons)

IkonliIcon	back to summary
pack-priv IkonliIcon(Color color, List<Ikon> icons)

IkonliIcon	back to summary
private IkonliIcon(List<Ikon> icons, @Nullable Color color, int size)

Method Detail

allIcons	back to summary
public static SequencedSet<Ikon> allIcons()

buildFontIcon	back to summary
private FontIcon buildFontIcon(Ikon ikon)

disabled	back to summary
public JabRefIcon disabled() Implements org.jabref.gui.icon.JabRefIcon.disabled. Annotations @Override

disabled

back to summary

public JabRefIcon disabled()

Implements org.jabref.gui.icon.JabRefIcon.disabled.

Annotations

@Override

findIcon	back to summary
public static Optional<JabRefIcon> findIcon(String code) Finds the Ikonli icon whose name matches `code` (case-insensitive).

findIconByDescription	back to summary
public static Optional<JabRefIcon> findIconByDescription(String description) Finds the Ikonli icon whose pack-qualified description matches `description` (case-insensitive).

getGraphicNode	back to summary
public Node getGraphicNode() Implements org.jabref.gui.icon.JabRefIcon.getGraphicNode. Annotations @Override

getGraphicNode

back to summary

public Node getGraphicNode()

Implements org.jabref.gui.icon.JabRefIcon.getGraphicNode.

Annotations

@Override

matches	back to summary
public boolean matches(Node graphicNode) Implements org.jabref.gui.icon.JabRefIcon.matches. Annotations @Override

matches

back to summary

public boolean matches(Node graphicNode)

Implements org.jabref.gui.icon.JabRefIcon.matches.

Annotations

@Override

name	back to summary
public String name() Implements org.jabref.gui.icon.JabRefIcon.name. Annotations @Override

name

back to summary

public String name()

Implements org.jabref.gui.icon.JabRefIcon.name.

Annotations

@Override

withColor	back to summary
public JabRefIcon withColor(Color color) Implements org.jabref.gui.icon.JabRefIcon.withColor. Annotations @Override

withColor

back to summary

public JabRefIcon withColor(Color color)

Implements org.jabref.gui.icon.JabRefIcon.withColor.

Annotations

@Override

withSize back to summary

withSize	back to summary
public JabRefIcon withSize(int size) Implements org.jabref.gui.icon.JabRefIcon.withSize. Doc from org.jabref.gui.icon.JabRefIcon.withSize. Returns a copy of this icon rendered at `size` pixels. Each implementation applies the size to its own backing node type, so callers (e.g. `JabRefIconView`) need not know whether it is a font or SVG node. Note the unit differs by backing type: for a font glyph `size` is the em/font size, so the glyph sits inside that box with the font's intrinsic padding; for an SVG the path is fitted edge-to-edge into a `size`×`size` square. The same `size` can thus render an SVG slightly larger than the font glyph. Annotations @Override

public JabRefIcon withSize(int size)

Implements org.jabref.gui.icon.JabRefIcon.withSize.

Doc from org.jabref.gui.icon.JabRefIcon.withSize.

Returns a copy of this icon rendered at size pixels. Each implementation applies the size to its own backing node type, so callers (e.g. JabRefIconView) need not know whether it is a font or SVG node.

Note the unit differs by backing type: for a font glyph size is the em/font size, so the glyph sits inside that box with the font's intrinsic padding; for an SVG the path is fitted edge-to-edge into a size×size square. The same size can thus render an SVG slightly larger than the font glyph.

Annotations

@Override

org.jabref.gui.icon back to summary

private final Class IkonliIcon.IkonliIcons

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.icon.IkonliIcon.IkonliIcons

Holds every Ikon discovered via the IkonProvider service loader. Initialization on first access guaranteed by JVM.

Field Summary

Modifier and Type	Field and Description
private static final SequencedSet<Ikon>	ALL
private static final Map<String, Ikon>	BY_DESCRIPTION
private static final Map<String, Ikon>	BY_NAME

Constructor Summary

Access	Constructor and Description
private	IkonliIcons()

Method Summary

Modifier and Type	Method and Description
private static SequencedSet<Ikon>	load()
private static Map<String, Ikon>	loadMap(Function<Ikon, String> keyMapper)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALL	back to summary
private static final SequencedSet<Ikon> ALL

BY_DESCRIPTION	back to summary
private static final Map<String, Ikon> BY_DESCRIPTION

BY_NAME	back to summary
private static final Map<String, Ikon> BY_NAME

Constructor Detail

IkonliIcons	back to summary
private IkonliIcons()

Method Detail

load	back to summary
private static SequencedSet<Ikon> load()

loadMap	back to summary
private static Map<String, Ikon> loadMap(Function<Ikon, String> keyMapper)

public final Class IkonliIcon

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class IkonliIcon.IkonliIcons

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail