Class IconSet


  • public class IconSet
    extends Object
    A collection of icons, with some properties to display them.
    Since:
    6.2M1
    Version:
    $Id: 10dcd4b41b7c2df066b0fabe5791609d3b0dce8c $
    • Constructor Detail

      • IconSet

        public IconSet​(String name)
        Constructor.
        Parameters:
        name - name of the icon set
    • Method Detail

      • getIcon

        public Icon getIcon​(String name)
        Parameters:
        name - name of the icon to get
        Returns:
        the icon corresponding to the given name
      • addIcon

        public void addIcon​(String name,
                            Icon icon)
        Add an icon to the icon set.
        Parameters:
        name - name of the icon
        icon - the icon to add
      • getName

        public String getName()
        Returns:
        the name of the icon set
      • setName

        public void setName​(String name)
        Set the name of the icon set.
        Parameters:
        name - the name to set
      • getCss

        public String getCss()
        Returns:
        the URL of a CSS file to enable to display this icon set properly, or null if it is not necessary
      • setCss

        public void setCss​(String css)
        Set the URL of a CSS file to enable to display this icon set properly.
        Parameters:
        css - URL of the CSS file (it can contains velocity code).
      • getSsx

        public String getSsx()
        Returns:
        the name of a SSX document to enable to display this icon set properly, or null if it is not necessary
      • setSsx

        public void setSsx​(String ssx)
        Set the page name of a SSX document to enable to display the icon set properly.
        Parameters:
        ssx - the SSX document name
      • getJsx

        public String getJsx()
        Returns:
        the name of a JSX document to enable to display this icon set properly, or null if it is not necessary
      • setJsx

        public void setJsx​(String jsx)
        Set the page name of a JSX document to enable to display the icon set properly.
        Parameters:
        jsx - the JSX document name
      • getRenderWiki

        public String getRenderWiki()
        Returns:
        the wiki code (containing velocity), to display an icon from this set.
      • setRenderWiki

        public void setRenderWiki​(String renderWiki)
        Set the wiki code (containing velocity) to display an icon from this set.
        Parameters:
        renderWiki - wiki code to set
      • getRenderHTML

        public String getRenderHTML()
        Returns:
        the HTML code (containing velocity) to display an icon from this set
      • setRenderHTML

        public void setRenderHTML​(String renderHTML)
        Set the HTML code (containing velocity) to display an icon from this set.
        Parameters:
        renderHTML - the HTML code to set
      • getIconUrl

        public String getIconUrl()
        Returns:
        the icon url
        Since:
        10.6RC1
      • setIconUrl

        public void setIconUrl​(String iconUrl)
        Set the url of the icon.
        Parameters:
        iconUrl - the icon url
        Since:
        10.6RC1
      • getIconCssClass

        public String getIconCssClass()
        Returns:
        the icon css class
        Since:
        10.6RC1
      • setIconCssClass

        public void setIconCssClass​(String iconCssClass)
        Set the css class of the icon.
        Parameters:
        iconCssClass - the icon css class
        Since:
        10.6RC1
      • getType

        public IconType getType()
        Returns:
        the type of icons that contains this set
      • setType

        public void setType​(IconType type)
        Set the type of icons that contains this set.
        Parameters:
        type - type to set
      • getIconNames

        public List<String> getIconNames()
        Returns:
        the list of names of all icons
        Since:
        6.4M1
      • hasIcon

        @Unstable
        public boolean hasIcon​(String iconName)
        Checks if the provided icon name exists in the icon set.
        Parameters:
        iconName - an icon name (for instance, @{code add})
        Returns:
        true if the icon name exists in the icon set, false otherwise
        Since:
        13.4RC1