Package com.inductiveautomation.factorypmi.designer.search

Class CachedComponent

java.lang.Object

com.inductiveautomation.factorypmi.designer.search.CachedComponent

public class CachedComponent
extends Object

Convenience object that encapsulates proper caching logic for holding onto a Component reference

Constructor Summary

Constructors

Constructor	Description
CachedComponent(InstanceCache cache, ResourcePath windowId, String componentPath)

Method Summary

Modifier and Type	Method	Description
void	changed()	You must call this if you modify this component so the system knows which windows to commit.
JComponent	component()	Finds the component for the given path.
InstanceCache	getCache()
CachedComponent	getChild(int index)
String	getComponentPath()
VisionDesignerInterface	getDesigner()
ResourcePath	getWindowId()
String	getWindowPath()	safe to call whether the window is open or not, unlike FPMIWindow.getPath()
WindowWorkspace	getWorkspace()
void	locate()	Opens the window in the WindowWorkspace and tries to select the component
TopLevelContainer	window()	Pulls the top level container for the component's parent's resource id out of the cache.

Methods inherited from class java.lang.Object

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

Constructor Details

CachedComponent

public CachedComponent(InstanceCache cache,
 ResourcePath windowId,
 String componentPath)

Method Details

component

public JComponent component()
                     throws WindowLockedException

Finds the component for the given path.

Throws:

WindowLockedException

window

public TopLevelContainer window()
                         throws WindowLockedException

Pulls the top level container for the component's parent's resource id out of the cache.

Throws:

WindowLockedException

getDesigner

public VisionDesignerInterface getDesigner()

getWorkspace

public WindowWorkspace getWorkspace()

changed

public void changed()

You must call this if you modify this component so the system knows which windows to commit.

locate

public void locate()

Opens the window in the WindowWorkspace and tries to select the component

getChild

public CachedComponent getChild(int index)
                         throws WindowLockedException

Throws:

WindowLockedException

getCache

public InstanceCache getCache()

getWindowId

public ResourcePath getWindowId()

getWindowPath

public String getWindowPath()

safe to call whether the window is open or not, unlike FPMIWindow.getPath()

getComponentPath

public String getComponentPath()