Package com.inductiveautomation.ignition.designer.location

Class LocationRenderingInfo

java.lang.Object

com.inductiveautomation.ignition.designer.location.LocationRenderingInfo

public class LocationRenderingInfo
extends Object

Builder class to hold rendering information for a particular Location for the platform.

Constructor Summary

Constructors

Constructor	Description
LocationRenderingInfo()

Method Summary

Modifier and Type	Method	Description
LocationRenderingInfo	addNamedPathElement(String name, String element)	Adds element to the current automatically built path, with a prefix of name Does nothing if element is null.
LocationRenderingInfo	addPathElement(String element)	Adds element to the current automatically built path, separated by ">" characters.
Icon	getIcon()
String	getLabel()
String	getTooltip()
boolean	isLocatable()
LocationRenderingInfo	setIcon(Icon icon)
LocationRenderingInfo	setLabel(String label)	Sets an arbitrary string to be used as the renderer for the supplied location.
LocationRenderingInfo	setLocatable(boolean locatable)
LocationRenderingInfo	setTooltip(String tooltip)

Methods inherited from class java.lang.Object

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

Constructor Details

LocationRenderingInfo

public LocationRenderingInfo()

Method Details

setLabel

public LocationRenderingInfo setLabel(String label)

Sets an arbitrary string to be used as the renderer for the supplied location.

See Also:

• addPathElement(String)

addPathElement

public LocationRenderingInfo addPathElement(@Nullable
 String element)

Adds element to the current automatically built path, separated by ">" characters. Does nothing if element is null.

See Also:

• setLabel(String)

addNamedPathElement

public LocationRenderingInfo addNamedPathElement(String name,
 String element)

Adds element to the current automatically built path, with a prefix of name Does nothing if element is null.

See Also:

• setLabel(String)

setIcon

public LocationRenderingInfo setIcon(Icon icon)

setTooltip

public LocationRenderingInfo setTooltip(String tooltip)

setLocatable

public LocationRenderingInfo setLocatable(boolean locatable)

getIcon

@Nullable
public Icon getIcon()

getTooltip

@Nullable
public String getTooltip()

getLabel

@Nonnull
public String getLabel()

isLocatable

public boolean isLocatable()