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 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 Details

    • NORMAL_SORT_PRIORITY

      public static final int NORMAL_SORT_PRIORITY
      The priority for normal elements.
      Since:
      21.1
      See Also:
    • SPLIT_ITEM_PRIORITY

      public static final int SPLIT_ITEM_PRIORITY
      The priority for "Split" / "New" type of entries.
      Since:
      21.1
      See Also:
  • Constructor Details

    • CCItemProxy

      public CCItemProxy()
  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns:
      The display name of the content completion item.
    • getIconPath

      public 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 String getDescription()
      Returns:
      The description for a given item.
    • getActionId

      public String getActionId()
      Returns:
      The action id, if this item is a replacement action item.
    • getAlias

      public 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.