Package ro.sync.ecss.extensions.api.webapp.cc

Class CCItemProxy

java.lang.Object

ro.sync.ecss.extensions.api.webapp.cc.CCItemProxy

All Implemented Interfaces:

AuthorCCItemTypes

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class CCItemProxy
extends java.lang.Object
implements AuthorCCItemTypes

An item proposed by the content completion manager, and which can be selected by the user. The item has a type, a name and a path for an icon to be displayed to the user that makes the selection.

Since:

15.1

Field Summary

Fields

Modifier and Type	Field	Description
static int	NORMAL_SORT_PRIORITY	The priority for normal elements.
static int	SPLIT_ITEM_PRIORITY	The priority for "Split" / "New" type of entries.

Fields inherited from interface ro.sync.ecss.contentcompletion.ccitems.AuthorCCItemTypes

CDATA_CC_ITEM, COMMENT_CC_ITEM, CUSTOM_ACTION_CC_ITEM, CUSTOM_ELEMENT_CC_ITEM, ELEMENT_CC_ITEM, ELEMENT_VALUE_CC_ITEM, LINE_BREAK_CC_ITEM, PI_CC_ITEM, SPLIT_CC_ITEM

Constructor Summary

Constructors

Constructor	Description
CCItemProxy()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getActionId()
java.lang.String	getAlias()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
CCItemProxy	getElementProxy()
java.lang.String	getIconPath()
int	getSortPriority()	This method returns the sort priority of a content completion item.
int	getType()
boolean	isUseActionName()

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_SORT_PRIORITY

public static final int NORMAL_SORT_PRIORITY

The priority for normal elements.

Since:

21.1

See Also:

Constant Field Values

SPLIT_ITEM_PRIORITY

public static final int SPLIT_ITEM_PRIORITY

The priority for "Split" / "New" type of entries.

Since:

21.1

See Also:

Constant Field Values

Constructor Detail

CCItemProxy

public CCItemProxy()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns:

The display name of the content completion item.

getIconPath

public java.lang.String getIconPath()

Returns:

The icon path of the content completion item.

getType

public int getType()

Returns:

The type of the content completion item.

getDescription

public java.lang.String getDescription()

Returns:

The description for a given item.

getActionId

public java.lang.String getActionId()

Returns:

The action id, if this item is a replacement action item.

getAlias

public java.lang.String getAlias()

Returns:

The alias to be used as rendering string, if this item is a replacement action item.

isUseActionName

public boolean isUseActionName()

Returns:

true to use the action name, if this item is a replacement action item.

getSortPriority

public int getSortPriority()

This method returns the sort priority of a content completion item. By default it is NORMAL_SORT_PRIORITY for all items except for "Split"-type entries which have a priority of SPLIT_ITEM_PRIORITY.

Returns:

Returns the sort priority. The larger the priority the upper in the list the element is promoted.

Since:

21.1

getElementProxy

public CCItemProxy getElementProxy()

Returns:

Returns the proxy of the replaced element, if this item is a replacement action item.