Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
AssetMap Class Reference
Inheritance diagram for AssetMap:
SimpleAssetMap

Public Member Functions

 AssetMap ()
 
void initialisationComplete (InitialisationEvent evt)
 
void init ()
 
void start ()
 
void loadParameters ()
 
void loadTranslations ()
 
void stop ()
 
void jsToJavaCall (String type, String command, String params)
 
void processAssetLocator (String params)
 
void keyPressed (KeyEvent e)
 
void keyTyped (KeyEvent e)
 
void keyReleased (KeyEvent e)
 
void componentAdded (ContainerEvent e)
 
void componentRemoved (ContainerEvent e)
 
void addKeyAndContainerListenerRecursively (Component c)
 
void removeKeyAndContainerListenerRecursively (Component c)
 

Static Public Member Functions

static AssetMap getApplet ()
 
static void getURL (String url) throws MalformedURLException
 
static void openWindow (String url, String title)
 

Static Public Attributes

static AssetMap applet
 
static final int POLLING_TIME = 2000
 

Protected Member Functions

void initAssetMap ()
 
void startPolling ()
 
JComponent createApplet ()
 

Static Protected Attributes

static JSObject window
 

Detailed Description

The main applet class

Author
Marc McIntyre mmcin.nosp@m.tyre.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Definition at line 40 of file AssetMap.java.

Constructor & Destructor Documentation

AssetMap ( )
inline

Constructs the Asset Map

Definition at line 53 of file AssetMap.java.

Member Function Documentation

JComponent createApplet ( )
inlineprotected

Creates the asset map's interface.

Returns
the compoent to add to the content pane.

Definition at line 347 of file AssetMap.java.

static void getURL ( String  url) throws MalformedURLException
inlinestatic

Opens the specfied url in the sq_main frame of the matrix system.

Parameters
urlthe url to open in the sq_main frame

Definition at line 74 of file AssetMap.java.

void init ( )
inline

Initialises the asset map.

See Also
start()
init()

Definition at line 98 of file AssetMap.java.

void initAssetMap ( )
inlineprotected

Initialises the asset map by making a request to the matrix system for the current assets and asset types in the system.

Definition at line 167 of file AssetMap.java.

void jsToJavaCall ( String  type,
String  command,
String  params 
)
inline

Method stub for javascript calls to java. Passes on the work to the JsEventManager to invoke the method in the listeners.

Parameters
typeThe type of event
commandThe event command. This is actually the name of the method that will eventually get called in the listener.

For Example.
When javascript invokes the asset finder, a command of AssetFinderStarted is passed as this argument, which will call the method AssetFinderStarted in any listeners implementing the interface AssetFinderListener.
paramsa serialised javascript array using the serialiseArray() function in fudge/var_serialise/var_serialize.js

Definition at line 376 of file AssetMap.java.

void loadParameters ( )
inline

Load the parameters from the applet tag and add them to our property set. Parameters are stored in the Matrix property set and can be accessed with:

 String prop = Matrix.getParameter("parameter." + propertyName);
See Also
Matrix.getParameter(String)

Definition at line 284 of file AssetMap.java.

void loadTranslations ( )
inline

Request the translations strings for use in the asset map and pass them off to a Matrix ResourceBundle.

Definition at line 298 of file AssetMap.java.

static void openWindow ( String  url,
String  title 
)
inlinestatic

Operns a new browser window to the specified url

Parameters
urlthe url to open
titlethe title to show in the browser window
See Also
getURL(String)

Definition at line 84 of file AssetMap.java.

void start ( )
inline

Starts the applet. This is where the initial request is made to the matrix system for the current assets and asset types. The request happens in a swing safe worker thread and the GUI is updated upon completion of the request.

See Also
JApplet.start()
stop()
init()

Definition at line 116 of file AssetMap.java.

void startPolling ( )
inlineprotected

Starts the polling operation to refresh assets that Matrix deems stale. The polling operation is polled at POLLING_TIME intervals. When javascript array is not empty, the assetids are used in a refresh operation.

See Also
POLLING_TIME

Definition at line 246 of file AssetMap.java.

void stop ( )
inline

Stops the asset map and polling.

See Also
start()
init()

Definition at line 338 of file AssetMap.java.


The documentation for this class was generated from the following file: