Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

addDocument

<static> void addDocument()

Create a new document within Adobe Photoshop.

changeGaussianFilter

<static> void changeGaussianFilter(<String> params)

The function first converts the parameter into a floating values and apply the Gaussian Blur filter to the smart object.

Parameters:
params - The parameters used for the Gaussian Blur filter

changeUnsharpFilter

<static> void changeUnsharpFilter(<String> params)

The function first splits the parameters into separate values and apply the unsharp mask filter to the smart object.

Parameters:
params - The parameters used for the Unsharp Mask filter

changeZigZagFilter

<static> void changeZigZagFilter(<String> params)

The function first splits the parameters into separate values and apply the zig zag filter to the smart object.

Parameters:
params - The parameters used for the Zig Zag filter

checkForSmartObject

<static> void checkForSmartObject()

Checks if the active layer is a smart object. If not, convert the layer to a smart object to be used by non-destructive filters.

closeDocument

<static> void closeDocument()

Close the active document within Adobe Photoshop.

convertToXML

<static> String convertToXML(<String> property, <String> identifier)

In order to communicate to the SWF file, it must be written as an XML containing the property and identifier. This utility is very helpful for a two-way communication between the JSX and SWF.

Parameters:
property - The property or value for the identifier
identifier - The unique identifier for the property

Returns:
An xml containing the property and identifier

exportLayerMetadata

<static> void exportLayerMetadata()

The function exports the raw metadata from the selected layer into the specified path by the user.

getBackground

<static> String getBackground()

Get the background color on Photoshop.

Returns:
An XML object containing the hex value of the foreground color.

getFilterLayerIndex

<static> Array getFilterLayerIndex(<String> fourCharID)

The function determines all the layers that have the same four character ID of the filter being searched.

Parameters:
fourCharID - The four character ID of the filter

Returns:
An array of the indexes of where the layer is located

getForeground

<static> String getForeground()

Get the foreground color on Photoshop.

Returns:
An XML object containing the hex value of the foreground color.

getLayerChangedDate

<static> String getLayerChangedDate()

The function finds the date and time in which the selected layer has been last modified.

Returns:
The date and time according to the locale of the computer

getLayerMetadata

<static> String getLayerMetadata()

Retrieve information on the layer includes its name, when it was last modified, the description from the Dublin Core metadata schema, and any of the user's comments from the EXIF metadata schema.

Returns:
An XML object containing the values for the variables: layerName, layerChangeDate, description, and comments of the layer that is currently selected.

loadXMPLibrary

<static> Boolean loadXMPLibrary()

The function loads the XMP Script Library.

Returns:
True if the XMP Script Library was loaded successfully.

setBackground

<static> void setBackground(<Integer> color)

Sets the background color on Photoshop.

Parameters:
color - An integer value that's ready to be parsed for RGB values.

setCommMetadata

<static> void setCommMetadata(<String> comm)

The function takes in the user comments input field from the user and place in the EXIF's description metadata field of the image.

Parameters:
comm - - User comments metadata the user wrote to be placed

setDescMetadata

<static> void setDescMetadata(<String> desc)

The function takes in the description input field from the user and places in the Dublin Core's description metadata field of the image.

Parameters:
desc - Description metadata the user wrote to be placed

setForeground

<static> void setForeground(<Integer> color)

Sets the foreground color on Photoshop.

Parameters:
color - An integer value that's ready to be parsed for RGB values.

styleToCharID

<static> String styleToCharID(<Integer> style)

The function determines the which style of zig zag to apply

Parameters:
style - The style of zig zag filter to apply

Returns:
Four character ID of the style the zig zag filter will apply

translateColor

<static> SolidColor translateColor(<Integer> c)

Take the integer value corresponding to a color and parse the values for red, green, and blue to SolidColor.

Parameters:
c - An integer value that's ready to be parsed for RGB values.

Returns:
The type SolidColor with red, green, and blue values parsed from "c".

unloadXMPLibrary

<static> void unloadXMPLibrary()

The function unloads the XMP Script Library.