Package com.inductiveautomation.ignition.client.icons

Class VectorIcons

java.lang.Object

com.inductiveautomation.ignition.client.icons.VectorIcons

public class VectorIcons
extends java.lang.Object

Represents a source of VectorIcon instances. This class is made to be used with a json source file which stores the source of the vector icons. The json format is expected to be an array of objects, each object containing "name" and "paths".

"name" is a string, the name/key of the icon. "paths" is an array of one or more strings. The strings must conform to the "d" attribute rules of an SVG path, see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d for reference.

This class also contains static accessors for a static instance of VectorIcons for all of the icons that are part of the Ignition platform itself.

Method Summary

Modifier and Type	Method	Description
static VectorIcons	createFromJson(java.io.Reader json)	Create a new instance of VectorIcons from a reader.
static VectorIcon	get(java.lang.String name)	Fetch an icon of the given name from the built-in icon source.
static VectorIcon	get(java.lang.String name, java.awt.Color color)	Fetch an icon of the given name from the built-in icon source.
VectorIcon	getIcon(java.lang.String name)
VectorIcon	getIcon(java.lang.String name, java.awt.Color color)
static InteractiveVectorIcon	getInteractive(java.lang.String name)	Fetch an icon from the built-in icon source, and return it as an InteractiveIcon
static InteractiveVectorIcon	getInteractive(java.lang.String name, java.awt.Color primary)
static InteractiveVectorIcon	getInteractive(java.lang.String name, java.awt.Color primary, java.awt.Color selected, java.awt.Color disabled, java.awt.Color focused)
static InteractiveVectorIcon	getInteractive(java.lang.String name, java.awt.Color primary, java.awt.Color selected, java.awt.Color disabled, java.awt.Color focused, java.awt.Color inherited)
InteractiveVectorIcon	getInteractiveIcon(java.lang.String name)
InteractiveVectorIcon	getInteractiveIcon(java.lang.String name, java.awt.Color primary, java.awt.Color selected, java.awt.Color disabled, java.awt.Color focused)
InteractiveVectorIcon	getInteractiveIcon(java.lang.String name, java.awt.Color primary, java.awt.Color selected, java.awt.Color disabled, java.awt.Color focused, java.awt.Color inherited)
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createFromJson

public static VectorIcons createFromJson(java.io.Reader json)

Create a new instance of VectorIcons from a reader. Once created, use getIcon(String) or getInteractive(String) to retrieve a specific icon from the supplied JSON.

Supply an icon named error to use a custom fallback icon (should an invalid name be provided) - if no error icon is provided, a default will be used.

get

@Nonnull
public static VectorIcon get(java.lang.String name)

Fetch an icon of the given name from the built-in icon source. Color will be IgnitionLookAndFeel.Colors.IconDefault

get

@Nonnull
public static VectorIcon get(java.lang.String name,
                             java.awt.Color color)

Fetch an icon of the given name from the built-in icon source.

Parameters:

name - Name of the icon

color - Color to use as fill

getIcon

@Nonnull
public VectorIcon getIcon(java.lang.String name)

getIcon

@Nonnull
public VectorIcon getIcon(java.lang.String name,
                          java.awt.Color color)

getInteractive

@Nonnull
public static InteractiveVectorIcon getInteractive(java.lang.String name)

Fetch an icon from the built-in icon source, and return it as an InteractiveIcon

getInteractive

@Nonnull
public static InteractiveVectorIcon getInteractive(java.lang.String name,
                                                   java.awt.Color primary)

getInteractive

@Nonnull
public static InteractiveVectorIcon getInteractive(java.lang.String name,
                                                   java.awt.Color primary,
                                                   java.awt.Color selected,
                                                   java.awt.Color disabled,
                                                   java.awt.Color focused)

getInteractive

@NotNull
public static InteractiveVectorIcon getInteractive(java.lang.String name,
                                                   java.awt.Color primary,
                                                   java.awt.Color selected,
                                                   java.awt.Color disabled,
                                                   java.awt.Color focused,
                                                   java.awt.Color inherited)

getInteractiveIcon

@Nonnull
public InteractiveVectorIcon getInteractiveIcon(java.lang.String name)

getInteractiveIcon

@Nonnull
public InteractiveVectorIcon getInteractiveIcon(java.lang.String name,
                                                java.awt.Color primary,
                                                java.awt.Color selected,
                                                java.awt.Color disabled,
                                                java.awt.Color focused)

getInteractiveIcon

@Nonnull
public InteractiveVectorIcon getInteractiveIcon(java.lang.String name,
                                                java.awt.Color primary,
                                                java.awt.Color selected,
                                                java.awt.Color disabled,
                                                java.awt.Color focused,
                                                java.awt.Color inherited)

main

public static void main(java.lang.String[] args)