Class AuthorAttributesDisplayFilter
- java.lang.Object
-
- ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter
-
@API(type=EXTENDABLE, src=PUBLIC) public abstract class AuthorAttributesDisplayFilter extends java.lang.Object
Filter certain attributes from being displayed in certain parts of the Author editor (the Attributes view, the Attributes editor, the Outline).- Since:
- 13
-
-
Field Summary
Fields Modifier and Type Field Description static int
SOURCE_ATTRIBUTES_VIEW
Source from where the callback is received.static int
SOURCE_CSS_CONTENT
Source from where the callback is received.static int
SOURCE_EDIT_PROPERTIES
Source from where the callback is received.static int
SOURCE_FULL_TAGS_WITH_ATTRS
Source from where the callback is received.static int
SOURCE_INSERT_REFERENCE
Source from where the callback is received.static int
SOURCE_OUTLINE_VIEW
Source from where the callback is received.
-
Constructor Summary
Constructors Constructor Description AuthorAttributesDisplayFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
shouldFilterAttribute(CIElement parentElement, java.lang.String attributeQName, int source)
Check if a certain attribute should be filtered from display.boolean
shouldFilterAttribute(AuthorElement parentElement, java.lang.String attributeQName, int source)
Check if a certain attribute should be filtered from display.
-
-
-
Field Detail
-
SOURCE_ATTRIBUTES_VIEW
public static final int SOURCE_ATTRIBUTES_VIEW
Source from where the callback is received. This type of source means that the callback is received either from the Attributes view associated to an Author page or from the in-place Attributes editor from either the Author or the DITA Maps Manager editing page.- See Also:
- Constant Field Values
-
SOURCE_OUTLINE_VIEW
public static final int SOURCE_OUTLINE_VIEW
Source from where the callback is received. This type of source means that the callback is received either from the Outline view associated to an Author page.- See Also:
- Constant Field Values
-
SOURCE_FULL_TAGS_WITH_ATTRS
public static final int SOURCE_FULL_TAGS_WITH_ATTRS
Source from where the callback is received. This type of source means that the callback is received when displaying the node in the Full Tags with Attributes in the Author page.- See Also:
- Constant Field Values
-
SOURCE_CSS_CONTENT
public static final int SOURCE_CSS_CONTENT
Source from where the callback is received. This type of source means that the callback is received when having CSS extension functions like attributes().- See Also:
- Constant Field Values
-
SOURCE_EDIT_PROPERTIES
public static final int SOURCE_EDIT_PROPERTIES
Source from where the callback is received. This type of source means that the callback is received from "Edit Properties" (available for DITA documents).- See Also:
- Constant Field Values
-
SOURCE_INSERT_REFERENCE
public static final int SOURCE_INSERT_REFERENCE
Source from where the callback is received. This type of source means that the callback is received from "Insert reference" dialogs (available for DITA documents).- See Also:
- Constant Field Values
-
-
Method Detail
-
shouldFilterAttribute
public boolean shouldFilterAttribute(AuthorElement parentElement, java.lang.String attributeQName, int source)
Check if a certain attribute should be filtered from display. This method should be implemented in subclasses.- Parameters:
parentElement
- The parent element.attributeQName
- The name of the attribute.source
- The place from which the attribute should be filtered. One of the constantsSOURCE_ATTRIBUTES_VIEW
orSOURCE_OUTLINE_VIEW
- Returns:
true
to avoid displaying the attribute.
-
shouldFilterAttribute
public boolean shouldFilterAttribute(CIElement parentElement, java.lang.String attributeQName, int source)
Check if a certain attribute should be filtered from display. This method should be implemented in subclasses.- Parameters:
parentElement
- The parent CI element.attributeQName
- The name of the attribute.source
- The place from which the attribute should be filtered. A possible value can beSOURCE_INSERT_REFERENCE
- Returns:
true
to avoid displaying the attribute.- Since:
- 18.1
-
-