ro.sync.ecss.extensions.api.attributes
Class AuthorAttributesDisplayFilter

java.lang.Object
  ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter

@API(type=EXTENDABLE,
     src=PUBLIC)
public 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

static int	SOURCE_ATTRIBUTES_VIEW Source from where the callback is received.
static int	SOURCE_OUTLINE_VIEW Source from where the callback is received.

Constructor Summary

AuthorAttributesDisplayFilter()

Method Summary

boolean

shouldFilterAttribute(AuthorElement parentElement, java.lang.String attributeQName, int source) Check if a certain attribute should be filtered from display.

Methods inherited from class java.lang.Object

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

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

Constructor Detail

AuthorAttributesDisplayFilter

public AuthorAttributesDisplayFilter()

Method Detail

shouldFilterAttribute

public boolean shouldFilterAttribute(AuthorElement parentElement,
                                     java.lang.String attributeQName,
                                     int source)

Check if a certain attribute should be filtered from display.

Parameters:

parentElement - The parent element.

attributeQName - The name of the attribute.

source - The place from which the attribute should be filtered. One of the constants SOURCE_ATTRIBUTES_VIEW or SOURCE_OUTLINE_VIEW

Returns:

true to avoid displaying the attribute.