Class AbstractShortcut

    • Constructor Detail

      • AbstractShortcut

        public AbstractShortcut()
    • Method Detail

      • getType

        public abstract java.util.TreeSet<Category> getType​(Member member)
      • setTextML

        public abstract void setTextML​(java.util.HashMap<java.lang.String,​java.lang.String> v)
      • setText

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

        public abstract java.lang.String getKeywords()
      • setKeywords

        public abstract void setKeywords​(java.lang.String v)
      • setKeywords

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

        public abstract java.util.HashMap<java.lang.String,​java.lang.String> getKeywordsML()
      • setKeywordsML

        public abstract void setKeywordsML​(java.util.HashMap<java.lang.String,​java.lang.String> v)
      • getShowInToolsPage

        public abstract boolean getShowInToolsPage()
      • setShowInToolsPage

        public abstract void setShowInToolsPage​(boolean v)
      • setPub

        public abstract void setPub​(Publication v)
      • getLink

        public abstract java.lang.String getLink​(java.lang.String lang)
      • setLink

        public abstract void setLink​(java.lang.String v)
      • getIcon

        public abstract java.lang.String getIcon​(java.lang.String lang)
      • setIcon

        public abstract void setIcon​(java.lang.String v)
      • getImage

        public abstract java.lang.String getImage​(java.lang.String lang)
      • setImage

        public abstract void setImage​(java.lang.String v)
      • getOpenMode

        public abstract java.lang.String getOpenMode()
      • setOpenMode

        public abstract void setOpenMode​(java.lang.String v)
      • getText

        public abstract java.lang.String getText()
      • getText

        public abstract java.lang.String getText​(java.lang.String lang)
      • setParameters

        public abstract void setParameters​(java.lang.String v)
      • getParameters

        public abstract java.lang.String getParameters()
      • getDataImage

        public java.lang.String getDataImage()
        Returns shortcut's icon if it is not empty.
        Overrides:
        getDataImage in class Publication
        Returns:
        a data image of this publication based on the image contains in its wiki or wysiwyg fields.
        Since:
        jcms-10.0.4
        See Also:
        Data.getDataImage()
      • getDataImage

        public java.lang.String getDataImage​(java.lang.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
      • performUpdate

        public void performUpdate​(Member mbr,
                                  java.util.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)
      • isExternalShortcut

        public boolean isExternalShortcut()
      • isPublicationShortcut

        public boolean isPublicationShortcut()
      • getUrl

        public java.lang.String getUrl​(java.util.Locale locale)
        An url to redirect to the target.

        In case of external link, parameters fields will be appended to getLink(String).

        Parameters:
        locale - the user locale
        Returns:
        the URL to use for this tool weither it is an external link or a publication link.
      • getAsyncShortcutInfoUrl

        public java.lang.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 java.lang.StringBuilder updateDisplayLinkHtmlAttributes​(java.lang.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 java.lang.StringBuilder updateDisplayLinkCss​(java.lang.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()