com.inductiveautomation.factorypmi.application.model

Class WindowCache

java.lang.Object

com.inductiveautomation.factorypmi.application.model.WindowCache

public class WindowCache
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WindowCache(ClientContext context)

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Object>	_legacyDeserialize(java.io.InputStream is, java.lang.Object owner)
void	applyDiff(Project diff, ProgressListener listener)
void	clear() Clears the entire cache.
void	clear(long id) Removes the id from the cache
void	clearCache() Clears the actual window references from any loaded WindowInfos
void	closeWindow(FPMIWindow window)
java.lang.Long	getAboutWindow()
java.util.List<java.lang.String>	getStartupWindows() Looks up the ids to all windows that are specified as startup windows
int	getWindowCompressedSize(long id)
int	getWindowCount()
WindowInfo	getWindowInfo(long id) Returns the WindowInfo for the window specified by the given resource id.
WindowInfo	getWindowInfo(java.lang.String path) Returns the WindowInfo for the window located at the given path.
java.util.List<java.lang.String>	getWindowNamesAlphabetical() Returns a flattened list of all window paths
java.awt.Dimension	getWindowSize(java.lang.String path) Returns a windows' size.
java.awt.image.BufferedImage	getWindowThumbnail(long id) Returns a thumbnail image for the named window, possibly null
boolean	isWindowOpen(long id) Deprecated.
boolean	isWindowOpen(java.lang.String path) Deprecated.
boolean	isWindowPresent(java.lang.String path)
FPMIWindow	openWindow(java.lang.String path, java.util.List<java.lang.String> credentials, boolean openAdditional) Returns the FPMIWindow object reference for the given window name.
void	setRootPaneContainer(javax.swing.RootPaneContainer rootPaneContainer)

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowCache

public WindowCache(ClientContext context)

Method Detail

applyDiff

public void applyDiff(Project diff,
                      ProgressListener listener)

setRootPaneContainer

public void setRootPaneContainer(javax.swing.RootPaneContainer rootPaneContainer)

getWindowInfo

public WindowInfo getWindowInfo(java.lang.String path)

Returns the WindowInfo for the window located at the given path. If the window doesn't exist, null is returned.

getWindowInfo

public WindowInfo getWindowInfo(long id)

Returns the WindowInfo for the window specified by the given resource id. If the window doesn't exist, null is returned.

_legacyDeserialize

public static java.util.List<java.lang.Object> _legacyDeserialize(java.io.InputStream is,
                                                                  java.lang.Object owner)
                                                           throws SerializationException

Throws:

SerializationException

clear

public void clear()

Clears the entire cache.

clear

public void clear(long id)

Removes the id from the cache

clearCache

public void clearCache()

Clears the actual window references from any loaded WindowInfos

getWindowCompressedSize

public int getWindowCompressedSize(long id)

getWindowCount

public int getWindowCount()

getWindowSize

public java.awt.Dimension getWindowSize(java.lang.String path)

Returns a windows' size. The window is deserialized if necessary, but then immediately closed. No locks are obtained.

Parameters:

path -

Returns:

isWindowPresent

public boolean isWindowPresent(java.lang.String path)

openWindow

public FPMIWindow openWindow(java.lang.String path,
                             java.util.List<java.lang.String> credentials,
                             boolean openAdditional)

Returns the FPMIWindow object reference for the given window name. If necessary (window is not already open), the window will be deserialized.

Parameters:

path -

credentials -

openAdditional -

Returns:

getStartupWindows

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

Looks up the ids to all windows that are specified as startup windows

getAboutWindow

public java.lang.Long getAboutWindow()

Returns:

Returns the id to the window to usa as an about window in the runtime.

getWindowThumbnail

public java.awt.image.BufferedImage getWindowThumbnail(long id)

Returns a thumbnail image for the named window, possibly null

closeWindow

public void closeWindow(FPMIWindow window)

isWindowOpen

@Deprecated
public boolean isWindowOpen(java.lang.String path)

Deprecated.

Use WindowWorkspace.isOpen() instead.

isWindowOpen

@Deprecated
public boolean isWindowOpen(long id)

Deprecated.

Use WindowWorkspace.isOpen() instead.

getWindowNamesAlphabetical

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

Returns a flattened list of all window paths