ro.sync.ecss.extensions.dita.map.topicref

Class TopicContentViewModeOperation

java.lang.Object

ro.sync.ecss.extensions.dita.map.topicref.TopicContentViewModeOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class TopicContentViewModeOperation
extends java.lang.Object

Operation used to configure Topic Content view mode.
This mode consists of:

• expanding topic references
• adding a pseudo-class on root to customize the document

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OXY_TOPIC_CONTENT_MODE PseudoClass set on root when enabled.

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 and Description
TopicContentViewModeOperation()

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
void	doOperation(AuthorAccess authorAccess, boolean enable) Equivalent as doOperation(AuthorAccess, ArgumentsMap)} but with interpreted ArgumentsMap.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()
protected int	getReferencesNumber(AuthorAccess authorAccess)
protected void	setPseudoclass(AuthorAccess authorAccess, boolean enable) Configure pseudoClass on root.

Methods inherited from class java.lang.Object

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

Field Detail

OXY_TOPIC_CONTENT_MODE

public static final java.lang.String OXY_TOPIC_CONTENT_MODE

PseudoClass set on root when enabled.

See Also:

Constant Field Values

Constructor Detail

TopicContentViewModeOperation

public TopicContentViewModeOperation()

Method Detail

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()

doOperation

public final 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(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

doOperation

public final void doOperation(AuthorAccess authorAccess,
                              boolean enable)
                       throws AuthorOperationException

Equivalent as doOperation(AuthorAccess, ArgumentsMap)} but with interpreted ArgumentsMap.

Parameters:

authorAccess - Author access.

enable - true to enable the mode, false otherwise.

Throws:

AuthorOperationException - If something goes wrong.

setPseudoclass

protected void setPseudoclass(AuthorAccess authorAccess,
                              boolean enable)

Configure pseudoClass on root.

Parameters:

authorAccess - Access to author.

enable - true if the pseudoClass should be enabled or not.

getReferencesNumber

protected int getReferencesNumber(AuthorAccess authorAccess)
                           throws AuthorOperationException

Parameters:

authorAccess - Author access.

Returns:

the number of references found in document.

Throws:

AuthorOperationException - If it fails.

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()