us.temerity.pipeline.plugin.GimpEditor.v2_2_1
Class GimpEditor

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseEditor
                  us.temerity.pipeline.BaseAppleScriptEditor
                      us.temerity.pipeline.plugin.GimpEditor.v2_2_1.GimpEditor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class GimpEditor
extends BaseAppleScriptEditor

The GNU Image Manipuation Program.

If the environmental variable GIMP_BINARY is defined, its value will be used as the name of the GIMP executable instead of the default "gimp" (Unix) or "gimp-2.2.exe" (Windows). On Windows, the GIMP program name should include the ".exe" extension. Mac OS X systems use Apple Script to launch GIMP and therefore ignore the name of the program binary.

See Also:

Serialized Form

Field Summary

Fields inherited from class us.temerity.pipeline.BasePlugin

pDescription

Fields inherited from class us.temerity.pipeline.PluginID

pVendor, pVersionID

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

GimpEditor()

Method Summary

SubProcessLight	launch(FileSeq fseq, Map<String,String> env, File dir) Deprecated.
SubProcessLight	prep(String author, FileSeq fseq, Map<String,String> env, File dir) Construct a SubProcessLight instance which when executed will launch an editor program to view the given file sequence as arguments.

Methods inherited from class us.temerity.pipeline.BaseEditor

cleanupLater, clone, createTemp, equals, getPluginType, getProgram, hasPrepMethod, ignoreExitCode, makeWorkingDirs, setProgram

Methods inherited from class us.temerity.pipeline.BasePlugin

addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment

Methods inherited from class us.temerity.pipeline.PluginID

fromGlue, getVendor, getVersionID, toGlue

Methods inherited from class us.temerity.pipeline.Named

getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GimpEditor

public GimpEditor()

Method Detail

prep

public SubProcessLight prep(String author,
                            FileSeq fseq,
                            Map<String,String> env,
                            File dir)
                     throws PipelineException

Construct a SubProcessLight instance which when executed will launch an editor program to view the given file sequence as arguments.

Overrides:

prep in class BaseAppleScriptEditor

Parameters:

author - The name of the user owning the files.

fseq - The file sequence to edit.

env - The environment under which the editor is run.

dir - The working directory where the editor is run.

Returns:

The controlling SubProcessLight instance.

Throws:

PipelineException - If unable to launch the editor.

See Also:

SubProcessLight

launch

@Deprecated
public SubProcessLight launch(FileSeq fseq,
                                         Map<String,String> env,
                                         File dir)
                       throws PipelineException

Deprecated.

This implementation always throws a PipelineException, to insure that the prep method is used for this Editor instead of this deprecated method.

Overrides:

launch in class BaseAppleScriptEditor

Parameters:

fseq - The file sequence to edit.

env - The environment under which the editor is run.

dir - The working directory where the editor is run.

Returns:

The controlling SubProcess instance.

Throws:

PipelineException - If unable to launch the editor.

See Also:

SubProcessLight