com.xmlmind.xmledit.cmd.select

Class ToggleCollapsed

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.select.ToggleCollapsed

All Implemented Interfaces:

Command, GadgetList

public final class ToggleCollapsed
extends CommandBase
implements GadgetList

Implementation of command toggleCollapsed.

Field Summary

Fields inherited from class com.xmlmind.xmledit.cmd.CommandBase

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
ToggleCollapsed()

Method Summary

Modifier and Type	Method and Description
void	appendGadget(Gadget gadget) Add specified gadget to this list.
void	appendGadgets(Gadget[] gadgets, int offset, int length) Add specified gadgets to this list.
static void	collapseAll(GadgetContainer container, boolean collapse)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
static void	showLevel(GadgetContainer container, int maxLevel, RootGadget rootGadget, int level)

Methods inherited from class com.xmlmind.xmledit.cmd.CommandBase

doExecuteByName, execute, executeCommand, isRecordable, isRepeatable, prepareCommand

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Constructor Detail

ToggleCollapsed

public ToggleCollapsed()

Method Detail

prepare

public boolean prepare(DocumentView docView,
                       String parameter,
                       int x,
                       int y)

Description copied from class: CommandBase

Tests whether this command can be executed with specified parameter and in specified context.

If the command can be executed, this method returns true after having configured its internal state for consumption by method CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) which should be invoked immediately after this one.

Returns false if this command cannot be executed with specified parameter and in specified context.

Specified by:

prepare in class CommandBase

Parameters:

docView - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

doExecute

public CommandResult doExecute(DocumentView docView,
                               String parameter,
                               int x,
                               int y)

Description copied from class: CommandBase

Actually executes this command with specified parameter and in specified context.

This method assumes that CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

IMPORTANT: application code which executes a command must always use CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or CommandBase.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) to do so, NOT CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int). CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is intended to be used only by commands which invoke helper "sub-commands".

Specified by:

doExecute in class CommandBase

Parameters:

docView - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

Returns:

the result of the command; may NOT be null.

If the command execution is successful and the command is repeatable and/or recordable then CommandResult.details field of the result is expected to be one of:

null

The repeat/record parameter is simply the parameter used as an argument of this method.

An Object

The repeat/record parameter is the string value of this object.

An array of 2 Strings

First string is the repeat/record parameter. Second string is the description of the command to be displayed by repeat commands.

appendGadget

public void appendGadget(Gadget gadget)

Description copied from interface: GadgetList

Add specified gadget to this list.

Specified by:

appendGadget in interface GadgetList

Parameters:

gadget - gadget to be added

appendGadgets

public void appendGadgets(Gadget[] gadgets,
                          int offset,
                          int length)

Description copied from interface: GadgetList

Add specified gadgets to this list.

Specified by:

appendGadgets in interface GadgetList

Parameters:

gadgets - gadgets to be added

offset - index within gadgets of first gadget to be added

length - number of gadgets to be added

collapseAll

public static final void collapseAll(GadgetContainer container,
                                     boolean collapse)

showLevel

public static final void showLevel(GadgetContainer container,
                                   int maxLevel,
                                   RootGadget rootGadget,
                                   int level)