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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonsOperationsUtil.ConversionElementHelper Interface used to check the elements that will be converted in other elements (table cells or list entries)
static class	CommonsOperationsUtil.SelectedFragmentInfo Class containing the new fragment and info about it.

Constructor Summary

Constructors

Constructor and Description
CommonsOperationsUtil()

Method Summary

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.net.URL	expandAndResolvePath(AuthorAccess authorAccess, java.lang.String path) Resolves a path relative to the framework directory.
static java.lang.String	getLocalName(java.lang.String qName) Get the local name from an qualified element or attribute name.
static java.lang.String	getPrefix(java.lang.String qName) Get the proxy from an qualified element or attribute name.
static java.util.List<CommonsOperationsUtil.SelectedFragmentInfo>	getSelectedFragmentsForConversions(AuthorAccess authorAccess, CommonsOperationsUtil.ConversionElementHelper helper) Get selected content fragments to be converted to cell or list entries fragments.
static java.net.URL	locateResourceInClasspath(AuthorAccess authorAccess, java.lang.String resourceFileName) Locate a certain resource in the classpath using its file name.
static java.util.List<javax.swing.text.Position>	removeCurrentSelection(AuthorAccess authorAccess) Remove current selection from Author.
static void	removeEmptyElements(AuthorAccess authorAccess, java.util.List<javax.swing.text.Position> emptyElementsPositions) Remove empty elements.
static void	removeUnwantedAttributes(java.lang.String[] skippedAttributes, AuthorDocumentFragment fragment, AuthorDocumentController controller) Remove unwanted attributes.
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 java.lang.String	setAttributeValue(AuthorDocumentController ctrl, AuthorElement targetElement, javax.xml.namespace.QName attributeQName, java.lang.String value, java.lang.String normalizedValue, 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. Inclusive.

end - The end offset. Inclusive.

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. Illegal characters in the value WILL NOT be escaped.

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.

setAttributeValue

public static java.lang.String setAttributeValue(AuthorDocumentController ctrl,
                                                 AuthorElement targetElement,
                                                 javax.xml.namespace.QName attributeQName,
                                                 java.lang.String value,
                                                 java.lang.String normalizedValue,
                                                 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. Illegal characters in the value WILL NOT be escaped. All entities must be already escaped in this value. For example:

ab"c&$

normalizedValue - The value with normalized whitespaces and expanded entities. For example:

ab"c&$

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.

locateResourceInClasspath

public static java.net.URL locateResourceInClasspath(AuthorAccess authorAccess,
                                                     java.lang.String resourceFileName)

Locate a certain resource in the classpath using its file name.

Parameters:

authorAccess - Author access.

resourceFileName - The resource file name.

Returns:

The URL of the resource or null.

expandAndResolvePath

public static java.net.URL expandAndResolvePath(AuthorAccess authorAccess,
                                                java.lang.String path)

Resolves a path relative to the framework directory. Editor variables are also accepted and expanded. The path is also passed through the catalog mappings.

Parameters:

authorAccess - Author access.

path - The path to resolve. Can be a file path, an URL path or a path relative to the framework directory. Editor variables are also accepted. The path is also passed through the catalog mappings.

Returns:

An URL or null if unable to expand the path to an URL.

getPrefix

public static java.lang.String getPrefix(java.lang.String qName)

Get the proxy from an qualified element or attribute name.

Parameters:

qName - q name

Returns:

the proxy or an empty string. Null if the argument is null.

getLocalName

public static java.lang.String getLocalName(java.lang.String qName)

Get the local name from an qualified element or attribute name.

Parameters:

qName - q name

Returns:

the local name, or null if the argument is null.

removeUnwantedAttributes

public static void removeUnwantedAttributes(java.lang.String[] skippedAttributes,
                                            AuthorDocumentFragment fragment,
                                            AuthorDocumentController controller)

Remove unwanted attributes.

Parameters:

skippedAttributes - The attributes to be deleted.

fragment - The author document fragment to be cleared.

controller - The author document controller.

removeCurrentSelection

public static java.util.List<javax.swing.text.Position> removeCurrentSelection(AuthorAccess authorAccess)

Remove current selection from Author.

Parameters:

authorAccess - Author access.

Returns:

A list with start positions for empty elements (after remove is done).

getSelectedFragmentsForConversions

public static java.util.List<CommonsOperationsUtil.SelectedFragmentInfo> getSelectedFragmentsForConversions(AuthorAccess authorAccess,
                                                                                                            CommonsOperationsUtil.ConversionElementHelper helper)
                                                                                                     throws AuthorOperationException

Get selected content fragments to be converted to cell or list entries fragments.

Parameters:

authorAccess - The author access.

helper - Used to check if the elements from selection can be converted in other elements (table cells or list entries)

Returns:

The selected content fragments to be converted to cell fragments.

Throws:

AuthorOperationException

removeEmptyElements

public static void removeEmptyElements(AuthorAccess authorAccess,
                                       java.util.List<javax.swing.text.Position> emptyElementsPositions)

Remove empty elements.

Parameters:

authorAccess - The Author access.

emptyElementsPositions - Positions for empty elements