Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.samples
Class TestCommand

java.lang.Object
  com.ibm.lpex.samples.TestCommand

All Implemented Interfaces:

LpexCommand

public class TestCommand

extends Object

implements LpexCommand

Sample command - display a short message. Running this command will display a short message on the editor message line.

Here is the TestCommand source code.

To run this sample:

• Define the command via an editor preference page, where available, or from the editor command line:

  set commandClass.testCommand com.ibm.lpex.samples.TestCommand

• Run it from the editor command line:

  testCommand

A user command is a Java class that implements the com.ibm.lpex.core.LpexCommand interface.

See Also:

All the samples

Constructor Summary

TestCommand()

Method Summary

boolean

doCommand(LpexView lpexView, String parameters) This method in the defined command will be called to run the command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestCommand

public TestCommand()

Method Detail

doCommand

public boolean doCommand(LpexView lpexView,
                         String parameters)

Description copied from interface: LpexCommand

This method in the defined command will be called to run the command.

The defined command should return false if the command syntax was incorrect (for example, missing or incorrect parameters), and true otherwise. When false is returned, an appropriate error message should preferably be displayed on the LPEX message line (using the set messageText editor command).

Specified by:

doCommand in interface LpexCommand

Parameters:

lpexView - the document view in which the command was issued

parameters - the command parameters