Class StaticRichTextConfiguration.StaticRichTextConfigurationTag
- java.lang.Object
-
- org.ametys.core.ui.widgets.richtext.StaticRichTextConfiguration.StaticRichTextConfigurationTag
-
- All Implemented Interfaces:
RichTextConfigurationTag
- Enclosing class:
- StaticRichTextConfiguration
public static class StaticRichTextConfiguration.StaticRichTextConfigurationTag extends Object implements RichTextConfigurationTag
A configured implementation of theRichTextConfigurationTag
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.ametys.core.ui.widgets.richtext.RichTextConfigurationTag
RichTextConfigurationTag.EMPTY_TAG
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<RichTextConfigurationAttribute>
_attributes
The handled attributesprotected RichTextConfigurationTag.EMPTY_TAG
_emptyTag
The empty behaviorprotected Set<String>
_synonyms
The synonymsprotected String
_tagName
The handled tag name
-
Constructor Summary
Constructors Modifier Constructor Description StaticRichTextConfigurationTag(String tagName, RichTextConfigurationTag.EMPTY_TAG emptyTag, Set<String> synonyms, Set<RichTextConfigurationAttribute> attributes)
Create by valuesprotected
StaticRichTextConfigurationTag(Configuration configuration)
Create by configuration
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<RichTextConfigurationAttribute>
getAttributes()
Get the attributes handled on this tagSet<String>
getSynonyms()
The tags that should be replaced by this one.String
getTag()
Get the tag name.RichTextConfigurationTag.EMPTY_TAG
onEmptyTag()
Determine the action to do when this tag is empty.
-
-
-
Field Detail
-
_emptyTag
protected RichTextConfigurationTag.EMPTY_TAG _emptyTag
The empty behavior
-
_attributes
protected Set<RichTextConfigurationAttribute> _attributes
The handled attributes
-
-
Constructor Detail
-
StaticRichTextConfigurationTag
public StaticRichTextConfigurationTag(String tagName, RichTextConfigurationTag.EMPTY_TAG emptyTag, Set<String> synonyms, Set<RichTextConfigurationAttribute> attributes)
Create by values- Parameters:
tagName
- The tag name. Cannot be null.emptyTag
- The behavior when empty. Can be null to use CLOSEsynonyms
- A set of synonymsattributes
- A set of authorized attributes
-
StaticRichTextConfigurationTag
protected StaticRichTextConfigurationTag(Configuration configuration) throws ConfigurationException
Create by configuration- Parameters:
configuration
- The tag configuration- Throws:
ConfigurationException
- If an error occurred
-
-
Method Detail
-
getTag
public String getTag()
Description copied from interface:RichTextConfigurationTag
Get the tag name. Such as 'span'.- Specified by:
getTag
in interfaceRichTextConfigurationTag
- Returns:
- The tag name. Cannot be empty or null.
-
onEmptyTag
public RichTextConfigurationTag.EMPTY_TAG onEmptyTag()
Description copied from interface:RichTextConfigurationTag
Determine the action to do when this tag is empty.- Specified by:
onEmptyTag
in interfaceRichTextConfigurationTag
- Returns:
- The behavior. Cannot be null.
-
getSynonyms
public Set<String> getSynonyms()
Description copied from interface:RichTextConfigurationTag
The tags that should be replaced by this one. For example, "b" should be replaced by "strong". Note that if "b" is handled otherwise, it will not be replaced.- Specified by:
getSynonyms
in interfaceRichTextConfigurationTag
- Returns:
- A non null set of tags.
-
getAttributes
public Set<RichTextConfigurationAttribute> getAttributes()
Description copied from interface:RichTextConfigurationTag
Get the attributes handled on this tag- Specified by:
getAttributes
in interfaceRichTextConfigurationTag
- Returns:
- A non null set of attributes.
-
-