Class PortletSkinable

    • Field Detail

      • abstractPortletSkinableClass

        public static java.lang.Class<?> abstractPortletSkinableClass

        public static final org.apache.oro.text.regex.Pattern PATTERN_CURRENT_CATEGORY

        public static final org.apache.oro.text.regex.Pattern PATTERN_CURRENT_CATEGORY_DESCRIPTION

        public static final org.apache.oro.text.regex.Pattern PATTERN_PORTAL_CATEGORY

        public static final org.apache.oro.text.regex.Pattern PATTERN_PORTAL_CATEGORY_DESCRIPTION
    • Constructor Detail

      • PortletSkinable

        public PortletSkinable()
      • PortletSkinable

        public PortletSkinable​(Publication other)
    • Method Detail

      • getAbstractPortletSkinableClass

        public static java.lang.Class<?> getAbstractPortletSkinableClass()
      • getSkinTitle

        public java.lang.String getSkinTitle​(java.lang.String userLang,
                                             Category current,
                                             Category portal)
      • getSkin

        public java.lang.String getSkin​(java.lang.String usage)
        Returns the template skin name for the given usage
        usage - the template usage
        String the name of the template used
      • getSkinTemplateEntry

        public TypeTemplateEntry getSkinTemplateEntry​(java.lang.String usage,
                                                      boolean devModeChecks)
        Returns the TypeTemplateEntry Skin matching the given parameters. It returns a default template if the given one does work.
        getSkinTemplateEntry in class PortalElement
        usage - the template usage
        devModeChecks - perform developement checks on template
        TypeTemplateEntry the matching templates
      • getSkinTemplateEntry

        public static TypeTemplateEntry getSkinTemplateEntry​(java.lang.String usage,
                                                             boolean devModeChecks,
                                                             java.lang.Class<? extends Publication> clazz,
                                                             Workspace ws)
        Returns the TypeTemplateEntry matching the given parameters. It returns a default template if the given one does work.
        usage - the template usage
        devModeChecks - perform developement checks on template
        clazz - the template publication class
        ws - the workspace where to create the publication
        TypeTemplateEntry the matching templates
      • setSkin

        public void setSkin​(java.lang.String name)
      • getDisplayTitleML

        public abstract java.util.HashMap<java.lang.String,​java.lang.String> getDisplayTitleML()
      • getDisplayTitle

        public abstract java.lang.String getDisplayTitle​(java.lang.String lang)
      • getDisplayTitle

        public abstract java.lang.String getDisplayTitle​(java.lang.String lang,
                                                         boolean b)
      • setDisplayTitle

        public abstract void setDisplayTitle​(java.lang.String s)
      • setDisplayTitleML

        public abstract void setDisplayTitleML​(java.util.HashMap<java.lang.String,​java.lang.String> s)
      • getDataName

        public java.lang.String getDataName​(java.lang.String language)
        Description copied from class: Data
        Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.
        • The Title (multi-language) for a Publication.
        • The Name (multi-language) for a Category.
        • The Name for a Group, a Member.
        • The Title (multi-language) for a Workspace.
        Can be seen as a smart multi-language toString(), but never returning null.
        Default behaviour is to return toFullString() of Data or empty string if toFullString is null.
        getDataName in class Publication
        language - the language in which to return the name if multilang available for the data.
        title of Publication in given language or empty String if not specified.
        See Also:
        Publication.getTitle(String), Data.getDataName(String)
      • getSkins

        public abstract java.lang.String[] getSkins()
      • setSkins

        public abstract void setSkins​(java.lang.String[] s)
      • getSkinClasses

        public abstract java.lang.String getSkinClasses()
      • setSkinClasses

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

        public abstract java.lang.String getSkinCSS()
      • setSkinCSS

        public abstract void setSkinCSS​(java.lang.String s)
      • getAvailableCssSkin

        public java.util.Map getAvailableCssSkin()
      • getPopupState

        public abstract java.lang.String getPopupState()
      • setPopupState

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

        public abstract java.lang.String getExpandState()
      • setExpandState

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

        public static <T extends Publication> java.util.Comparator<T> getContentTitleComparator​(java.lang.String userLang)
        Retrieve a new instance of ContentTitleComparator sorting publication according to their title.
        Type Parameters:
        T - the type of portlet being compared
        userLang - the iso-639 language code in which title will be retrieve to perform sorting
        a new instance of PortletSkinable.ContentTitleComparator.
      • getSkinHeaderIcon

        public abstract java.lang.String getSkinHeaderIcon()
      • getSkinHeaderIconColor

        public abstract java.lang.String getSkinHeaderIconColor()
      • setSkinHeaderIcon

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

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

        public abstract java.lang.String getSkinHeaderButtonLabel​(java.lang.String lang,
                                                                  boolean useDefault)
      • getSkinHeaderButtonLabel

        public abstract java.lang.String getSkinHeaderButtonLabel()
      • getSkinHeaderButtonLabelML

        public abstract java.util.HashMap<java.lang.String,​java.lang.String> getSkinHeaderButtonLabelML()
      • setSkinHeaderButtonLabelML

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

        public abstract void setSkinHeaderButtonLabel​(java.lang.String lang,
                                                      java.lang.String value)
      • setSkinFooterButtonLabelML

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

        public abstract void setSkinFooterButtonLabel​(java.lang.String lang,
                                                      java.lang.String value)
      • getSkinHeaderButtonLink

        public abstract java.lang.String getSkinHeaderButtonLink()
      • setSkinHeaderButtonLink

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

        public abstract java.lang.String getSkinFooterButtonLink()
      • setSkinFooterButtonLink

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

        public abstract java.lang.String getSkinFooterButtonAlign()
      • setSkinFooterButtonAlign

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

        public abstract java.lang.String getSkinHeaderSubText()
      • setSkinHeaderSubText

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

        public abstract java.lang.String getSkinHeaderSubText​(java.lang.String lang)
      • getSkinHeaderSubText

        public abstract java.lang.String getSkinHeaderSubText​(java.lang.String lang,
                                                              boolean useDefault)
      • getSkinHeaderSubTextML

        public abstract java.util.HashMap<java.lang.String,​java.lang.String> getSkinHeaderSubTextML()
      • setSkinHeaderSubTextML

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

        public abstract java.lang.String getSkinHeaderSubTextMLE()
      • setSkinHeaderSubTextMLE

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

        public abstract void setSkinHeaderSubText​(java.lang.String lang,
                                                  java.lang.String value)