ro.sync.ecss.extensions.commons.operations

Class CommonsOperationsUtil

java.lang.Object

ro.sync.ecss.extensions.commons.operations.CommonsOperationsUtil

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

Util methods for common Author operations.

Constructor Summary

Constructors

Constructor and Description
CommonsOperationsUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildFreshPrefix(NamespaceContext namespaceContext) Generates a prefix that is not yet bound to a namespace.
static java.lang.String	setAttributeValue(AuthorDocumentController ctrl, AuthorElement targetElement, javax.xml.namespace.QName attributeQName, java.lang.String value, boolean removeIfEmpty) Sets an attribute value.
static void	surroundWithFragment(AuthorAccess authorAccess, boolean schemaAware, java.lang.String xmlFragment) Surround selection with fragment.
static int	surroundWithFragment(AuthorAccess authorAccess, java.lang.String xmlFragment, int start, int end) Surround the content between start and end offset with the given fragment.
static void	unwrapTags(AuthorAccess authorAccess, AuthorNode nodeToUnwrap) Unwrap node tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonsOperationsUtil

public CommonsOperationsUtil()

Method Detail

unwrapTags

public static void unwrapTags(AuthorAccess authorAccess,
              AuthorNode nodeToUnwrap)
                       throws javax.swing.text.BadLocationException

Unwrap node tags.

Parameters:

authorAccess - The Author access.

nodeToUnwrap - The node to unwrap.

Throws:

javax.swing.text.BadLocationException

surroundWithFragment

public static void surroundWithFragment(AuthorAccess authorAccess,
                        boolean schemaAware,
                        java.lang.String xmlFragment)
                                 throws AuthorOperationException

Surround selection with fragment.

Parameters:

authorAccess - Author access.

schemaAware - true for schema aware operation

xmlFragment - The xml fragment

Throws:

AuthorOperationException

surroundWithFragment

public static int surroundWithFragment(AuthorAccess authorAccess,
                       java.lang.String xmlFragment,
                       int start,
                       int end)
                                throws AuthorOperationException

Surround the content between start and end offset with the given fragment.

Parameters:

authorAccess - Author access.

xmlFragment - The xml fragment

start - The start offset.

end - The end offset.

Returns:

Insertion offset.

Throws:

AuthorOperationException

setAttributeValue

public static java.lang.String setAttributeValue(AuthorDocumentController ctrl,
                                 AuthorElement targetElement,
                                 javax.xml.namespace.QName attributeQName,
                                 java.lang.String value,
                                 boolean removeIfEmpty)

Sets an attribute value. If the value is null the attribute will be removed from the element. If the value is the empty string and removeIfEmpty is true the attribute will also be removed.

Parameters:

ctrl - Attribute controller.

targetElement - The target element.

attributeQName - Attribute to edit.

value - Current value.

removeIfEmpty - true to remove the attribute when an empty value is set.

Returns:

The QName with which the attribute was committed. From the given attributeQName only the local name and namespace are taken into account.

buildFreshPrefix

public static java.lang.String buildFreshPrefix(NamespaceContext namespaceContext)

Generates a prefix that is not yet bound to a namespace.

Parameters:

namespaceContext - Namespace context.

Returns:

A prefix not bound in the given context.