org.xbup.io.command

Interface XBCommand

public interface XBCommand

Interface for XBUP document command.

Version:

0.1 wr20.0 2010/09/12

Author:

XBUP Project (http://xbup.org)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCaption() Get caption as text
XBBasicCommandType	getOpType() Get revert step type
void	perform(XBEditableDocument document) Perform operation on given document.
void	revert(XBEditableDocument document) Perform revert operation on given document.
boolean	supportRevert() Returns true if command support revert operation.

Method Detail

getOpType

XBBasicCommandType getOpType()

Get revert step type

getCaption

java.lang.String getCaption()

Get caption as text

perform

void perform(XBEditableDocument document)
             throws java.lang.Exception

Perform operation on given document.

Parameters:

document - a document to perform operation on.

Throws:

java.lang.Exception

revert

void revert(XBEditableDocument document)
            throws java.lang.Exception

Perform revert operation on given document.

Parameters:

document - a document to perform operation on.

Throws:

java.lang.Exception

supportRevert

boolean supportRevert()

Returns true if command support revert operation.

Returns:

true if revert supported.