com.brightech.mb.workflow.js

Class JSPreviewManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSPreviewManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSPreviewManager
extends JSBaseScriptableObject

Provides access to a preview manager for javascript objects Is available in workflow context pre-initialized as "previewManager"

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSPreviewManager()

Method Summary

Modifier and Type	Method and Description
void	(JavaScript Function) addRequest(java.lang.String theFormat, int theAssetId, User theUser, java.lang.String theOutputPath, java.lang.String theScale, java.lang.String theResolution, java.lang.String theColorspace) Deprecated. use (JavaScript Function) addRequestForAsset(int theAssetId, User theUser, Parameters theParameters) instead
int	(JavaScript Function) addRequestForAsset(int theAssetId, User theUser, Parameters theParameters) Add loading dock request to queue.
java.lang.String	(JavaScript Function) addRequestForFile(java.lang.String theFilePath, java.lang.String theOutPath, java.lang.String theFormat, boolean theWait) Add a request for any file to be converted to a new format.
java.lang.String	(JavaScript Function) addRequestForFileTempOutput(java.lang.String theFilePath, java.lang.String theFormat, boolean theWait) Add a request for any file to be converted to a new format and automatically create a temporary output path.
void	(JavaScript Function) addScriptRequest(ManagedFile theAsset, java.lang.String theOutputPath, java.lang.String theScriptPath, java.lang.Boolean theEditsOriginal, Parameters theParameters) Add a request to have the preview system execute a script asynchronously.
void	(JavaScript Function) regeneratePreview(ManagedFile theFile) Regenerate previews for a specific asset

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSPreviewManager

public JSPreviewManager()

Method Detail

(JavaScript Function) regeneratePreview

public void (JavaScript Function) regeneratePreview(ManagedFile theFile)
                                  throws FileSystemException

Regenerate previews for a specific asset

Parameters:

theFile - the file to regenerate previews for

Throws:

FileSystemException - exception throw if issue w/file

(JavaScript Function) addRequest

public void (JavaScript Function) addRequest(java.lang.String theFormat,
                                  int theAssetId,
                                  User theUser,
                                  java.lang.String theOutputPath,
                                  java.lang.String theScale,
                                  java.lang.String theResolution,
                                  java.lang.String theColorspace)

Deprecated. use (JavaScript Function) addRequestForAsset(int theAssetId, User theUser, Parameters theParameters) instead

Add loading dock request to queue. Conversion is asynchronously executed.

Parameters:

theFormat - the format, e.g. "JPEG".

theAssetId - the asset ID, an integer.

theUser - the user object.

theOutputPath - the output path If a custom output path is defined, the request will not appear in the loading dock.

theScale - the scale to convert to. E.g. "50%x50%".

theResolution - the resolution to convert to. E.g. "72dpi", "300dpi", or "350x400" (pixels).

theColorspace - the colorspace to convert to. E.g. "RGB".

(JavaScript Function) addScriptRequest

public void (JavaScript Function) addScriptRequest(ManagedFile theAsset,
                                        java.lang.String theOutputPath,
                                        java.lang.String theScriptPath,
                                        java.lang.Boolean theEditsOriginal,
                                        Parameters theParameters)

Add a request to have the preview system execute a script asynchronously. Added to the preview queue, not the loading dock queue.

Parameters:

theAsset - The original asset to generate a preview of.

theOutputPath - The file to output the preview to.

theScriptPath - The script to run.

theEditsOriginal - Does the script edit the original asset?

theParameters - Additional optional parameters to pass to the script worker (these paramters do not necessarily propagate to the script itself).

(JavaScript Function) addRequestForAsset

public int (JavaScript Function) addRequestForAsset(int theAssetId,
                                         User theUser,
                                         Parameters theParameters)

Add loading dock request to queue. Conversion is asynchronously executed.

Parameters:

theAssetId - the asset ID

theUser - the user

theParameters - the parameters for the conversion

(JavaScript Function) addRequestForFile

public java.lang.String (JavaScript Function) addRequestForFile(java.lang.String theFilePath,
                                                     java.lang.String theOutPath,
                                                     java.lang.String theFormat,
                                                     boolean theWait)
                                              throws java.net.MalformedURLException

Add a request for any file to be converted to a new format.

Parameters:

theFilePath - Full path of file to be converted

theOutPath - Full path of conversion output

theFormat - Format to convert to

theWait - true to wait for processing to complete, false otherwise

Returns:

Download URL for converted file

Throws:

java.net.MalformedURLException - Error creating downoad url

(JavaScript Function) addRequestForFileTempOutput

public java.lang.String (JavaScript Function) addRequestForFileTempOutput(java.lang.String theFilePath,
                                                               java.lang.String theFormat,
                                                               boolean theWait)
                                                        throws java.io.IOException

Add a request for any file to be converted to a new format and automatically create a temporary output path.

Parameters:

theFilePath - Full path of file to be converted

theFormat - Full path of conversion output

theWait - true to wait for processing to complete, false otherwise

Returns:

Download URL for converted file

Throws:

java.io.IOException - Error creating temp file or download url