Class AbstractShortcut

All Implemented Interfaces:
EditableData, JcmsConstants, ImportConstants, MashupConstants, StrongLockable, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, Cloneable, Comparable<BasicStorable>

public abstract class AbstractShortcut extends Content
  • Field Details

  • Constructor Details

    • AbstractShortcut

      public AbstractShortcut()
    • AbstractShortcut

      public AbstractShortcut(AbstractShortcut other)
  • Method Details

    • getType

      public abstract TreeSet<Category> getType(Member member)
    • setTextML

      public abstract void setTextML(HashMap<String,String> v)
    • setText

      public abstract void setText(String lang, String value)
    • getKeywords

      public abstract String getKeywords()
    • setKeywords

      public abstract void setKeywords(String v)
    • setKeywords

      public abstract void setKeywords(String lang, String value)
    • getKeywordsML

      public abstract HashMap<String,String> getKeywordsML()
    • setKeywordsML

      public abstract void setKeywordsML(HashMap<String,String> v)
    • getShowInToolsPage

      public abstract boolean getShowInToolsPage()
    • setShowInToolsPage

      public abstract void setShowInToolsPage(boolean v)
    • getPub

      public abstract Publication getPub()
    • setPub

      public abstract void setPub(Publication v)
    • getLink

      public abstract String getLink(String lang)
    • setLink

      public abstract void setLink(String v)
    • getIcon

      public abstract String getIcon(String lang)
    • setIcon

      public abstract void setIcon(String v)
    • getImage

      public abstract String getImage(String lang)
    • setImage

      public abstract void setImage(String v)
    • getOpenMode

      public abstract String getOpenMode()
    • setOpenMode

      public abstract void setOpenMode(String v)
    • getText

      public abstract String getText()
    • getText

      public abstract String getText(String lang)
    • setParameters

      public abstract void setParameters(String v)
    • getParameters

      public abstract String getParameters()
    • getDataImage

      public String getDataImage()
      Returns shortcut's icon if it is not empty.
      Overrides:
      getDataImage in class Data
      Returns:
      a path relative to the webapp root.
      Since:
      jcms-10.0.4
    • getDataImage

      public String getDataImage(String lang, boolean useDefault)
      Returns shortcut's icon if it is not empty.
      Overrides:
      getDataImage in class Data
      Parameters:
      lang - the user language (ISO-639 language code)
      useDefault - should the default language be used if no value is found for the specified language
      Returns:
      a path relative to the webapp root.
      Since:
      jcms-10.0.4
    • getDataIcon

      public String getDataIcon()
      Returns the application icon used by the launcher for the current member.
      Overrides:
      getDataIcon in class Publication
      Returns:
      a relative path (eg images/jalios/icon/abstract.gif) or sprite classes name (eg ss_sprite ss_date).
      See Also:
    • checkIntegrity

      public ControllerStatus checkIntegrity()
      Prevents the shortcut to reference itself as a Publication.
      Overrides:
      checkIntegrity in class Publication
      Returns:
      a ControllerStatus
      See Also:
    • performUpdate

      public void performUpdate(Member mbr, Map context)
      Description copied from class: Publication
      Performs data update
      Overrides:
      performUpdate in class Publication
      Parameters:
      mbr - the member which requests the write operation
      context - a map which contains context parameters (may be null)
    • getType

      public AbstractShortcut.TYPE getType()
    • isExternalShortcut

      public boolean isExternalShortcut()
    • isPublicationShortcut

      public boolean isPublicationShortcut()
    • getUrl

      public String getUrl(Locale locale)
      An url to redirect to the target.

      Parameters fields will be appended to either the external link, or the publication displayUrl.

      Parameters:
      locale - the user locale
      Returns:
      the URL to redirect to
    • getShortcutInfo

      public ShortcutInfo getShortcutInfo(Member mbr)
      Parameters:
      mbr - the Member
      Returns:
      a ShortcutInfo for current Shortcut and given Member
    • getAsyncShortcutInfoUrl

      public String getAsyncShortcutInfoUrl()
      Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)
      Returns:
      an url
    • updateDisplayLinkHtmlAttributes

      public StringBuilder updateDisplayLinkHtmlAttributes(StringBuilder builder)
      Description copied from class: Data
      Returns a StringBuilder which contains html attributes, whom you can modify or replace in your subclasses
      Overrides:
      updateDisplayLinkHtmlAttributes in class Data
      Parameters:
      builder - the StringBuilder
      Returns:
      a StringBuilder which contains html attributes of display link
    • updateDisplayLinkCss

      public StringBuilder updateDisplayLinkCss(StringBuilder builder)
      Description copied from class: Data
      Returns a StringBuilder which contains css, whom you can modify or replace in your subclasses
      Overrides:
      updateDisplayLinkCss in class Publication
      Parameters:
      builder - the StringBuilder
      Returns:
      a StringBuilder which contains css of display link
    • isOpenNewPage

      public boolean isOpenNewPage()
    • isOpenModal

      public boolean isOpenModal()
    • getPropertyName

      public String getPropertyName()