Package ro.sync.ecss.extensions.commons.operations

Class PseudoClassOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.PseudoClassOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

RemovePseudoClassOperation, SetPseudoClassOperation, TogglePseudoClassOperation

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class PseudoClassOperation
extends java.lang.Object
implements AuthorOperation

A base class for the operations that changes a pseudo-class from an element.

See Also:

TogglePseudoClassOperation, SetPseudoClassOperation, RemovePseudoClassOperation

Field Summary

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
PseudoClassOperation()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
protected abstract void	execute(AuthorAccess authorAccess, java.lang.String pseudoClassName, AuthorElement targetElement)	Executes a pseudo-class change to an element.
ArgumentDescriptor[]	getArguments()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

PseudoClassOperation

public PseudoClassOperation()

Constructor.

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. You can check if the operation was invoked from the oXygen standalone application or from the oXygen plugin for Eclipse by using the method: ApplicationInformationAccess.getPlatform(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:

doOperation in interface AuthorOperation

Parameters:

authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.

args - The map of arguments. All the arguments defined by method AuthorOperation.getArguments() must be present in the map of arguments.

Throws:

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(AuthorAccess, ArgumentsMap)

execute

protected abstract void execute(AuthorAccess authorAccess,
                                java.lang.String pseudoClassName,
                                AuthorElement targetElement)

Executes a pseudo-class change to an element.

Parameters:

authorAccess - The access.

pseudoClassName - The name of the pseudo class.

targetElement - The element that is changed.

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()