us.temerity.pipeline
Class SingleEditor

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseEditor
                  us.temerity.pipeline.SingleEditor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

Direct Known Subclasses:

AcroreadEditor, AcroreadEditor, AcroreadEditor, DviViewerEditor, EvinceEditor, EvinceEditor, ExpertEditor, FoxitEditor, GPlayEditor, GPlayEditor, GPlayEditor, HoudiniEditor, HoudiniEditor, HoudiniEditor, LyxEditor, MayaCompleteEditor, MayaEditor, MayaEditor, MayaEditor, MayaEditor, MayaProjectEditor, RealFlowEditor, XDviEditor, XDviEditor, XSIEditor

Deprecated. This class does not implement the new prep method and exists solely to support existing Editor plugins already derrived from this class.

@Deprecated
public class SingleEditor
extends BaseEditor

Superclass of Pipline node editor plugins that can only edit single files.

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

protected	SingleEditor() Deprecated. This constructor is required by the GlueDecoder to instantiate the class when encountered during the reading of GLUE format files and should not be called from user code.
protected	SingleEditor(String name, VersionID vid, String vendor, String desc, String program) Deprecated. Construct with a name and description.

Method Summary

SubProcessLight

launch(FileSeq fseq, Map<String,String> env, File dir) Deprecated. Unlike the prep method, the convention is for this method to also execute the generated SubProcessLight instance. New subclasses should implement the prep method instead to allow the caller a chance to execute the process as another user. Namely, as the owner of the files being edited. The owner of the files is passes as an additional argument to prep called (author) which must be passed on as a constructor argument of the generated SubProcessLight instance.

Methods inherited from class us.temerity.pipeline.BaseEditor

cleanupLater, clone, createTemp, equals, getPluginType, getProgram, hasPrepMethod, ignoreExitCode, makeWorkingDirs, prep, 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

SingleEditor

protected SingleEditor()

Deprecated.

This constructor is required by the GlueDecoder to instantiate the class when encountered during the reading of GLUE format files and should not be called from user code.

SingleEditor

protected SingleEditor(String name,
                       VersionID vid,
                       String vendor,
                       String desc,
                       String program)

Deprecated.

Construct with a name and description.

Parameters:

name - The short name of the editor.

vid - The action plugin revision number.

vendor - The name of the plugin vendor.

desc - A short description used in tooltips.

program - A name of the editor executable.

Method Detail

launch

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

Deprecated. Unlike the prep method, the convention is for this method to also execute the generated SubProcessLight instance. New subclasses should implement the prep method instead to allow the caller a chance to execute the process as another user. Namely, as the owner of the files being edited. The owner of the files is passes as an additional argument to prep called (author) which must be passed on as a constructor argument of the generated SubProcessLight instance.

Launch the editor program (obtained with getName) under the given environmant with all of the files which comprise the given file sequence as arguments. The environment env consists of a table of environmental variable name/value pairs. Typically, this environment is corresponds to a Toolset.

Subclasses should override this method if more specialized behavior or different command line arguments are needed in order to launch the editor for the given file sequence.

Overrides:

launch in class BaseEditor

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