us.temerity.pipeline.plugin.ExplorerEditor.v2_2_1
Class ExplorerEditor

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class ExplorerEditor
extends BaseEditor

The Windows Explorer Graphical File Browser

In order to use this Editor properly, the windows machine this is running on must have the following flag set: In Control Panel -> Folder Options -> View -> Advanced Settings, the "Launch folder windows in a separate process" option must be set to true. If this is option is not set, then the Editor won't be able to properly initialize the environment from the Toolset.

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

ExplorerEditor()

Method Summary

boolean	ignoreExitCode() Whether Pipeline programs which launch Editor plugins should ignore the exit code returned by the Subprocess created in the prep method.
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, 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

ExplorerEditor

public ExplorerEditor()

Method Detail

ignoreExitCode

public boolean ignoreExitCode()

Description copied from class: BaseEditor

Whether Pipeline programs which launch Editor plugins should ignore the exit code returned by the Subprocess created in the prep method.

By default, this method always returns false. Subclasses which run 3rd party applications which always return non-zero (failure) error codes may consider overriding this method to return true to suppress bogus error messages.

Overrides:

ignoreExitCode in class BaseEditor

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 BaseEditor

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 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