VcsCommandVisualizer (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.commands
Interface VcsCommandVisualizer

All Known Implementing Classes:: CommandOutputVisualizer

public interface VcsCommandVisualizer

This class should be used to display the graphical output of the running command. the open method is called to open the visualizer. The implementing class must have a default constructor.

Nested Class Summary

static interface VcsCommandVisualizer.Wrapper
          The wrapper of the visualizer.

Method Summary

boolean doesDisplayError()
          Whether this visualizer handles failed commands.

void errOutputData(String[] data)
          Receive the error data output of the visualized command.

void errOutputLine(String line)
          Receive a line of error output of the visualized command.

boolean isOpened()
          Tell, whether the visualizer is currently opened.

void open(VcsCommandVisualizer.Wrapper wrapper)
          Open the visualizer.

boolean openAfterCommandFinish()
          Tells when the open method should be called.

void requestFocus()
          Request the focus for this visualizer.

void setExitStatus(int exit)
          This method is called when the command finishes.

void setOutputCollector(CommandOutputCollector outputCollector)
          After instatiation this method is called with the collector of output, that can be used for various purposes in the visualizer.

void setPossibleFileStatusInfoMap(Map infoMap)
          After instatiation this method is called with the map of all possible file statuses.

void setVcsTask(VcsDescribedTask task)
          After instatiation this method is called with the task that should be visualized.

void stdOutputData(String[] data)
          Receive the data output of the visualized command.

void stdOutputLine(String line)
          Receive a line of standard output of the visualized command.

Method Detail

setVcsTask

public void setVcsTask(VcsDescribedTask task)

After instatiation this method is called with the task that should be visualized. Do not attach listeners for the output data here, use the *Output* methods instead. The task can be already finished when this method is called.

setOutputCollector

public void setOutputCollector(CommandOutputCollector outputCollector)

After instatiation this method is called with the collector of output, that can be used for various purposes in the visualizer.

setPossibleFileStatusInfoMap

public void setPossibleFileStatusInfoMap(Map infoMap)

After instatiation this method is called with the map of all possible file statuses. The map contains raw file status strings as keys and appropriate FileStatusInfo objects as values.

Returns:: The file status map.

setExitStatus

public void setExitStatus(int exit)

This method is called when the command finishes.

Parameters:: exit - the exit status of the command.

openAfterCommandFinish

public boolean openAfterCommandFinish()

Tells when the open method should be called.

Returns:: true -- this component will be opened after the command finish its execution, false -- this component will be opened just before the command is started.

doesDisplayError

public boolean doesDisplayError()

Whether this visualizer handles failed commands.

stdOutputLine

public void stdOutputLine(String line)

Receive a line of standard output of the visualized command.

errOutputLine

public void errOutputLine(String line)

Receive a line of error output of the visualized command.

stdOutputData

public void stdOutputData(String[] data)

Receive the data output of the visualized command.

errOutputData

public void errOutputData(String[] data)

Receive the error data output of the visualized command.

open

public void open(VcsCommandVisualizer.Wrapper wrapper)

Open the visualizer. If there is a GUI wrapper defined, that wrapper should be used to display the visualizer.

Parameters:: wrapper - The GUI wrapper or null

isOpened

public boolean isOpened()

Tell, whether the visualizer is currently opened. This method is used to decide whether open() should be called or not.

requestFocus

public void requestFocus()

Request the focus for this visualizer. See TopComponent.requestFocus().