com.cognifide.qa.bb.aem.dialog.classic.field.tags

Class AemTags

java.lang.Object

com.cognifide.qa.bb.aem.dialog.classic.field.tags.AemTags

All Implemented Interfaces:

Configurable, Iterable<AemTagItem>

public class AemTags
extends Object
implements Iterable<AemTagItem>, Configurable

Tags window in a AemDialog.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE_SEPARATOR Colon.
static String	PARENT_PATH_SEPARATOR Slash.

Constructor Summary

Constructors

Constructor and Description
AemTags()

Method Summary

Modifier and Type	Method and Description
AemTags	addTag(String tag) Adds a tag.
AemTags	addTag(String namespace, String pathAndTagName) Adds new tag.
AemTags	clear() Remove all tags from the field.
AemTagItem	getTagItem(String text) Method to search for tag item.
Iterator<AemTagItem>	iterator()
AemTags	removeTag(String text) Search for item with provided text getTagItem(String) and then invoke remove method.
void	setValue(String value) Sets the value in AemElement.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

NAMESPACE_SEPARATOR

public static final String NAMESPACE_SEPARATOR

Colon.

See Also:

Constant Field Values

PARENT_PATH_SEPARATOR

public static final String PARENT_PATH_SEPARATOR

Slash.

See Also:

Constant Field Values

Constructor Detail

AemTags

public AemTags()

Method Detail

clear

public AemTags clear()

Remove all tags from the field.

Returns:

This AemTags instance.

removeTag

public AemTags removeTag(String text)

Search for item with provided text getTagItem(String) and then invoke remove method.

Parameters:

text - tag text

Returns:

This AemTags instance.

getTagItem

public AemTagItem getTagItem(String text)

Method to search for tag item. Input text is quite flexible - for example to find tag: "Facebook:Test/MyTagName", the text parameter can be either "Facebook:Test/MyTagName", "Test/MyTagName" or "MyTagName". Be aware that text parameter is case sensitive and in case of possible many results method will return the first one. If an element has not been found then null will be returned.

Parameters:

text - tag text

Returns:

AemTag if found. Null otherwise.

addTag

public AemTags addTag(String namespace,
                      String pathAndTagName)
               throws DeniedTagException

Adds new tag. Parameters are case sensitive.

Parameters:

namespace - - e.g. Facebook, if null or blank default namespace is used

pathAndTagName - - path to tag e.g. Location/MyTagName

Returns:

This AemTags instance.

Throws:

DeniedTagException - if tag is denied

addTag

public AemTags addTag(String tag)
               throws DeniedTagException

Adds a tag. Assumed format of tag attribute: Namespace:Tag1/Tag2/Tag3 or Tag1/Tag2/Tag3 if creating tag in default namespace.

Parameters:

tag - e.g. Facebook:Test/MyTagName, Test/MyTagName

Returns:

This AemTags instance.

Throws:

DeniedTagException - if tag is denied

iterator

public Iterator<AemTagItem> iterator()

Specified by:

iterator in interface Iterable<AemTagItem>

size

public int size()

Returns:

Numbers of already selected tags.

setValue

public void setValue(String value)

Description copied from interface: Configurable

Sets the value in AemElement.

Specified by:

setValue in interface Configurable

Parameters:

value - configuration value to be set