Package com.inductiveautomation.ignition.client.util

Class ClientIconUtil

java.lang.Object

com.inductiveautomation.ignition.client.util.ClientIconUtil

public class ClientIconUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientIconUtil.Size

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	C_AP
static java.lang.String	C_APPLICATION_BASICS
static java.lang.String	C_BD
static java.lang.String	C_BUSINESS_DATA
static java.lang.String	C_NETWORK_SECURITY
static java.lang.String	C_NS
static java.lang.String	C_OBJECT_PEOPLE
static java.lang.String	C_OP
static java.lang.String	C_SD
static java.lang.String	C_SOFTWARE_DEVELOPMENT
static ClientIconUtil.Size	S_16
static ClientIconUtil.Size	S_24
static ClientIconUtil.Size	S_32
static ClientIconUtil.Size	S_48

Method Summary

Modifier and Type	Method	Description
static javax.swing.ImageIcon	applyBadge(javax.swing.Icon base, javax.swing.Icon badge)
static javax.swing.ImageIcon	getIcon(java.lang.String name)
static javax.swing.ImageIcon	getIcon(java.lang.String name, ClientIconUtil.Size size)
static javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String category)	Deprecated.
static javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String category, ClientIconUtil.Size size)	Deprecated.
static javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String category, java.lang.String size)	Deprecated.
static javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String category, java.lang.String size, java.lang.String style)	Deprecated.
static javax.swing.ImageIcon	getRootIcon(java.lang.Class relativeClass, java.lang.String path)	Retrieves an image located in the specified class's *.jar file.
static javax.swing.ImageIcon	getRootIcon(java.lang.String path)
static javax.swing.ImageIcon	scaleIcon(java.lang.String iconName, int height, float opacity)
static javax.swing.ImageIcon	scaleIcon(java.lang.String iconName, ClientIconUtil.Size size, int height, float opacity)
static javax.swing.ImageIcon	scaleIcon(javax.swing.ImageIcon icon, int height, float opacity)	Scales an icon to the given height.

Methods inherited from class java.lang.Object

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

Field Detail

C_AP

public static final java.lang.String C_AP

See Also:

Constant Field Values

C_BD

public static final java.lang.String C_BD

See Also:

Constant Field Values

C_NS

public static final java.lang.String C_NS

See Also:

Constant Field Values

C_OP

public static final java.lang.String C_OP

See Also:

Constant Field Values

C_SD

public static final java.lang.String C_SD

See Also:

Constant Field Values

C_APPLICATION_BASICS

public static final java.lang.String C_APPLICATION_BASICS

See Also:

Constant Field Values

C_BUSINESS_DATA

public static final java.lang.String C_BUSINESS_DATA

See Also:

Constant Field Values

C_NETWORK_SECURITY

public static final java.lang.String C_NETWORK_SECURITY

See Also:

Constant Field Values

C_OBJECT_PEOPLE

public static final java.lang.String C_OBJECT_PEOPLE

See Also:

Constant Field Values

C_SOFTWARE_DEVELOPMENT

public static final java.lang.String C_SOFTWARE_DEVELOPMENT

See Also:

Constant Field Values

S_16

public static final ClientIconUtil.Size S_16

S_24

public static final ClientIconUtil.Size S_24

S_32

public static final ClientIconUtil.Size S_32

S_48

public static final ClientIconUtil.Size S_48

Method Detail

getIcon

@Deprecated
public static javax.swing.ImageIcon getIcon(java.lang.String name,
                                            java.lang.String category)

Deprecated.

Categories are no longer used

getIcon

@Deprecated
public static javax.swing.ImageIcon getIcon(java.lang.String name,
                                            java.lang.String category,
                                            java.lang.String size)

Deprecated.

Categories are no longer used.

getIcon

@Deprecated
public static javax.swing.ImageIcon getIcon(java.lang.String name,
                                            java.lang.String category,
                                            ClientIconUtil.Size size)

Deprecated.

Categories are no longer used.

getIcon

@Deprecated
public static javax.swing.ImageIcon getIcon(java.lang.String name,
                                            java.lang.String category,
                                            java.lang.String size,
                                            java.lang.String style)

Deprecated.

Categories are no longer used.

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String name)

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String name,
                                            ClientIconUtil.Size size)

getRootIcon

public static javax.swing.ImageIcon getRootIcon(java.lang.String path)

getRootIcon

public static javax.swing.ImageIcon getRootIcon(java.lang.Class relativeClass,
                                                java.lang.String path)

Retrieves an image located in the specified class's *.jar file. It attempts to load the image by looking for it at: "images/path"

scaleIcon

public static javax.swing.ImageIcon scaleIcon(javax.swing.ImageIcon icon,
                                              int height,
                                              float opacity)

Scales an icon to the given height. The width will be proportional. Opacity can range from [0.0-transparent] to [1.0-opaque]

scaleIcon

public static javax.swing.ImageIcon scaleIcon(java.lang.String iconName,
                                              int height,
                                              float opacity)

scaleIcon

public static javax.swing.ImageIcon scaleIcon(java.lang.String iconName,
                                              ClientIconUtil.Size size,
                                              int height,
                                              float opacity)

applyBadge

public static javax.swing.ImageIcon applyBadge(javax.swing.Icon base,
                                               javax.swing.Icon badge)