Package com.inductiveautomation.perspective.designer.model

Class ComponentPath

java.lang.Object

com.inductiveautomation.perspective.designer.model.ComponentPath

public class ComponentPath
extends java.lang.Object

Represents a path to a component, supporting the logic needed to derive the most appropriate relative path to reference one component from another.

Field Summary

Fields

Modifier and Type	Field	Description
static ComponentPath	PAGE
static java.lang.String	PAGE_SHORTCUT
static ComponentPath	PARENT
static java.lang.String	PARENT_SHORTCUT
static java.lang.String	SESSION_SHORTCUT
static ComponentPath	THIS
static java.lang.String	THIS_SHORTCUT
static ComponentPath	VIEW
static java.lang.String	VIEW_SHORTCUT

Constructor Summary

Constructors

Constructor	Description
ComponentPath(java.lang.String... parts)
ComponentPath(java.util.List<java.lang.String> parts)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getLastPart()
java.util.List<java.lang.String>	getParts()
boolean	isAnyShortcut()
boolean	isPage()
boolean	isParent()
boolean	isRelative()
boolean	isSession()
boolean	isThis()
boolean	isView()
ComponentPath	relativePathTo(ComponentPath destination)	Creates a ComponentPath that will resolve to the given destination path when evaluated from the context of the component represented by this path.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_SHORTCUT

public static final java.lang.String SESSION_SHORTCUT

See Also:

Constant Field Values

VIEW_SHORTCUT

public static final java.lang.String VIEW_SHORTCUT

See Also:

Constant Field Values

PAGE_SHORTCUT

public static final java.lang.String PAGE_SHORTCUT

See Also:

Constant Field Values

THIS_SHORTCUT

public static final java.lang.String THIS_SHORTCUT

See Also:

Constant Field Values

PARENT_SHORTCUT

public static final java.lang.String PARENT_SHORTCUT

See Also:

Constant Field Values

VIEW

public static final ComponentPath VIEW

PAGE

public static final ComponentPath PAGE

THIS

public static final ComponentPath THIS

PARENT

public static final ComponentPath PARENT

Constructor Detail

ComponentPath

public ComponentPath(java.lang.String... parts)

ComponentPath

public ComponentPath(java.util.List<java.lang.String> parts)

Method Detail

getLastPart

public java.lang.String getLastPart()

getParts

public java.util.List<java.lang.String> getParts()

isSession

public boolean isSession()

isPage

public boolean isPage()

isView

public boolean isView()

isParent

public boolean isParent()

isThis

public boolean isThis()

isAnyShortcut

public boolean isAnyShortcut()

isRelative

public boolean isRelative()

relativePathTo

public ComponentPath relativePathTo(ComponentPath destination)

Creates a ComponentPath that will resolve to the given destination path when evaluated from the context of the component represented by this path.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object