Package ro.sync.ecss.extensions.docbook

Class DocbookInsertListOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.InsertListOperation

ro.sync.ecss.extensions.docbook.DocbookInsertListOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

DB4InsertListOperation, DB5InsertListOperation

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class DocbookInsertListOperation
extends InsertListOperation

Docbook Insert List operation,

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ITEMIZED_LIST	Itemized list constant.
static java.lang.String	LIST_TYPE_ARGUMENT	Argument that controls the type of the list that will be inserted.
protected static java.lang.String	ORDERED_LIST	Ordered list constant.
protected static java.lang.String	PROCEDURE	Procedure constant.
protected static java.lang.String	VARIABLE_LIST	Variable list constant.

Fields inherited from class ro.sync.ecss.extensions.commons.operations.InsertListOperation

authorAccess, CONVERT_ELEMENT_AT_CARET_ARGUMENT, CONVERT_ELEMENT_AT_CARET_ARGUMENT_DESCRIPTOR, listType, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

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

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT

Constructor Summary

Constructors

Constructor	Description
DocbookInsertListOperation()

Method Summary

Modifier and Type	Method	Description
ArgumentDescriptor[]	getArguments()
protected CommonsOperationsUtil.ConversionElementHelper	getConversionElementsChecker()	Get the conversion element checker.
java.lang.String	getDescription()
protected java.lang.String	getListTypeDescription(java.lang.String listType)	Obtain the name of every list type.
protected java.lang.StringBuilder	getListXMLFragment(java.lang.String listType, java.util.Map<java.lang.String,java.lang.String> attributes, int numberOfListItems, AuthorAccess authorAccess)	Get list XML fragment.
protected java.lang.String	getParentListType(AuthorNode nodeAtOffset)	Get the type of the list in which the new list will be inserted.
protected java.lang.String	getXMLFragment(AuthorAccess authorAccess, java.lang.String listType, java.lang.String parentListType)	Get XML fragment to be inserted when nothing is selected.
protected void	insertContent(AuthorAccess authorAccess, AuthorNode listNode, java.util.List<CommonsOperationsUtil.SelectedFragmentInfo> selectedFragmentsInfos)	Insert content.
protected boolean	isList(AuthorNode node)	Checks if the given node is a list.
protected boolean	isListElement(AuthorNode node)	Checks if the given node is a list element or list item.

Methods inherited from class ro.sync.ecss.extensions.commons.operations.InsertListOperation

doOperation, getElementAtCaretToConvert, getNamespace

Methods inherited from class java.lang.Object

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

Field Detail

ORDERED_LIST

protected static final java.lang.String ORDERED_LIST

Ordered list constant.

See Also:

Constant Field Values

ITEMIZED_LIST

protected static final java.lang.String ITEMIZED_LIST

Itemized list constant.

See Also:

Constant Field Values

VARIABLE_LIST

protected static final java.lang.String VARIABLE_LIST

Variable list constant.

See Also:

Constant Field Values

PROCEDURE

protected static final java.lang.String PROCEDURE

Procedure constant.

See Also:

Constant Field Values

LIST_TYPE_ARGUMENT

public static final java.lang.String LIST_TYPE_ARGUMENT

Argument that controls the type of the list that will be inserted.

See Also:

Constant Field Values

Constructor Detail

DocbookInsertListOperation

public DocbookInsertListOperation()

Method Detail

getListXMLFragment

protected java.lang.StringBuilder getListXMLFragment(java.lang.String listType,
                                                     java.util.Map<java.lang.String,java.lang.String> attributes,
                                                     int numberOfListItems,
                                                     AuthorAccess authorAccess)

Description copied from class: InsertListOperation

Get list XML fragment.

Specified by:

getListXMLFragment in class InsertListOperation

Parameters:

listType - The list type.

attributes - The attributes to add to list items.

numberOfListItems - The number of list items.

authorAccess - The author access.

Returns:

The list XML fragment.

See Also:

InsertListOperation.getListXMLFragment(java.lang.String, java.util.Map, int, ro.sync.ecss.extensions.api.AuthorAccess)

getXMLFragment

protected java.lang.String getXMLFragment(AuthorAccess authorAccess,
                                          java.lang.String listType,
                                          java.lang.String parentListType)

Description copied from class: InsertListOperation

Get XML fragment to be inserted when nothing is selected.

Specified by:

getXMLFragment in class InsertListOperation

Parameters:

authorAccess - The author access.

listType - The type of the list to be inserted.

parentListType - The type of the parent list, can be null

Returns:

the fragment to be inserted.

getArguments

public ArgumentDescriptor[] getArguments()

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()

insertContent

protected void insertContent(AuthorAccess authorAccess,
                             AuthorNode listNode,
                             java.util.List<CommonsOperationsUtil.SelectedFragmentInfo> selectedFragmentsInfos)

Description copied from class: InsertListOperation

Insert content.

Specified by:

insertContent in class InsertListOperation

Parameters:

authorAccess - The author access.

listNode - The list node.

selectedFragmentsInfos - The fragments to be inserted.

See Also:

InsertListOperation.insertContent(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorNode, java.util.List)

getConversionElementsChecker

protected CommonsOperationsUtil.ConversionElementHelper getConversionElementsChecker()

Description copied from class: InsertListOperation

Get the conversion element checker.

Specified by:

getConversionElementsChecker in class InsertListOperation

Returns:

The conversion element checker.

See Also:

InsertListOperation.getConversionElementsChecker()

getParentListType

protected java.lang.String getParentListType(AuthorNode nodeAtOffset)

Description copied from class: InsertListOperation

Get the type of the list in which the new list will be inserted. Can be null.

Specified by:

getParentListType in class InsertListOperation

Parameters:

nodeAtOffset - The node at offset.

Returns:

the type of the list in which the new list will be inserted. Can be null.

See Also:

InsertListOperation.getParentListType(ro.sync.ecss.extensions.api.node.AuthorNode)

isListElement

protected boolean isListElement(AuthorNode node)

Description copied from class: InsertListOperation

Checks if the given node is a list element or list item.

Overrides:

isListElement in class InsertListOperation

Parameters:

node - The element to check.

Returns:

true if the node is a list element.

See Also:

InsertListOperation.isListElement(ro.sync.ecss.extensions.api.node.AuthorNode)

isList

protected boolean isList(AuthorNode node)

Description copied from class: InsertListOperation

Checks if the given node is a list.

Specified by:

isList in class InsertListOperation

Parameters:

node - The element to check.

Returns:

true if the node is a list.

See Also:

InsertListOperation.isList(ro.sync.ecss.extensions.api.node.AuthorNode)

getListTypeDescription

protected java.lang.String getListTypeDescription(java.lang.String listType)

Description copied from class: InsertListOperation

Obtain the name of every list type.

Specified by:

getListTypeDescription in class InsertListOperation

Parameters:

listType - The list type.

Returns:

A string representing the name of the given list type.

See Also:

InsertListOperation.getListTypeDescription(java.lang.String)