JabRef 6.0-beta.1 · org.jabref.gui.icon.JabRefIconView

View for a JabRefIcons usable in FXML (e.g. <JabRefIconView glyph="REFRESH"/>).

Hosts the backing node produced by JabRefIcons#getGraphicNode() instead of being a FontIcon itself, so it renders both Ikonli-font-backed glyphs (as a FontIcon) and SVG-backed glyphs (see SvgIcon, rendered as a JabRefSvgIcon).

Theme coloring is handled by the hosted child itself (a FontIcon or JabRefSvgIcon, both of which carry the icon style classes), so this view stays unclassed to avoid double-theming. The styleable -fx-icon-color here is an explicit override knob — e.g. an inline style="-fx-icon-color: ..." in FXML — and, when set, is forwarded to an SVG child as a color (overriding theme CSS).

Field Summary

Modifier and Type	Field and Description
private static final CssMetaData<JabRefIconView, Paint>	COLOR
private final StyleableObjectProperty<Paint>	color CSS-styleable color, fed by `-fx-icon-color` rules (e.g. an inline `style="-fx-icon-color: ..."`).
private static final List<CssMetaData<? extends Styleable, ?>>	CSS_META_DATA
private final ObjectProperty<IconTheme.JabRefIcons>	glyph This property is only needed to get proper IDE support in FXML files (e.g. validation that parameter passed to "icon" is indeed of type `IconTheme.JabRefIcons`).
private final ObjectProperty<Number>	glyphSize

Constructor Summary

Access	Constructor and Description
public	JabRefIconView(IconTheme.JabRefIcons icon, int size)
public	JabRefIconView(IconTheme.JabRefIcons icon)
public	JabRefIconView()

Method Summary

Modifier and Type	Method and Description
private void	applyColor() Forwards an explicit `color` override to an SVG child.
public static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData() Hides javafx.scene.Node.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.Node.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public IconTheme.JabRefIcons	getGlyph()
public Number	getGlyphSize()
public ObjectProperty<IconTheme.JabRefIcons>	glyphProperty()
public ObjectProperty<Number>	glyphSizeProperty()
private void	initialize()
public void	setGlyph(IconTheme.JabRefIcons icon)
public void	setGlyphSize(Number value)
private void	updateGraphic() Rebuilds the hosted node from the current glyph, sized to the current glyph size.

Inherited from javafx.scene.Group:: autoSizeChildrenProperty getChildren isAutoSizeChildren layoutChildren minHeight minWidth prefHeight prefWidth setAutoSizeChildren

Field Detail

COLOR	back to summary
private static final CssMetaData<JabRefIconView, Paint> COLOR

color	back to summary
private final StyleableObjectProperty<Paint> color CSS-styleable color, fed by `-fx-icon-color` rules (e.g. an inline `style="-fx-icon-color: ..."`). Forwarded to an SVG child as a fixed color.

CSS_META_DATA	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> CSS_META_DATA

glyph	back to summary
private final ObjectProperty<IconTheme.JabRefIcons> glyph This property is only needed to get proper IDE support in FXML files (e.g. validation that parameter passed to "icon" is indeed of type `IconTheme.JabRefIcons`).

glyphSize	back to summary
private final ObjectProperty<Number> glyphSize

Constructor Detail

JabRefIconView	back to summary
public JabRefIconView(IconTheme.JabRefIcons icon, int size)

JabRefIconView	back to summary
public JabRefIconView(IconTheme.JabRefIcons icon)

JabRefIconView	back to summary
public JabRefIconView()

Method Detail

applyColor	back to summary
private void applyColor() Forwards an explicit `color` override to an SVG child. `JabRefSvgIcon#setColor(Paint)` fixes the color there, so it beats the author `.ikonli-font-icon { -fx-icon-color }` theme rule the child also matches. When unset (the common case) the child colors itself from theme CSS, so it is left untouched.

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.Node.getClassCssMetaData.

Doc from javafx.scene.Node.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.Node.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.Node.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations

@Override

getGlyph	back to summary
public IconTheme.JabRefIcons getGlyph()

getGlyphSize	back to summary
public Number getGlyphSize()

glyphProperty	back to summary
public ObjectProperty<IconTheme.JabRefIcons> glyphProperty()

glyphSizeProperty	back to summary
public ObjectProperty<Number> glyphSizeProperty()

initialize	back to summary
private void initialize()

setGlyph	back to summary
public void setGlyph(IconTheme.JabRefIcons icon)

setGlyphSize	back to summary
public void setGlyphSize(Number value)