Class SkinProperties


  • public class SkinProperties
    extends java.lang.Object
    Representation of the (optional) skin.properties file of skins
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String AUTHOR  
      static java.lang.String AUTO_WIDGET_INJECTION
      Tell if jAlbum is to automatically inject Widget loader code into generate pages (done manually with the <ja:widget> tag) Valid values are true and false.
      static java.lang.String COMPANY  
      static java.lang.String COMPATIBILITY_MODE
      Skins that rely on the deprecated "fileVariables" object can set this flag to true in order to still work with jALbum 10.3 and up The fileVariables object is a memory eater so please rewrite your skins to avoid its use.
      static java.lang.String CREATION_DATE
      Format YYYY-MM-DD
      static java.lang.String DESCRIPTION  
      static java.lang.String EDITABLE_THEME_IMAGE_SIZE
      Boolean (true/false) flag stating whether this skin allows the user to edit the theme image size and crop region through the theme image selector of the folder property panel.
      static java.lang.String ENABLE_THUMBNAIL_LAYOUT
      Tell jAlbum to use enable or disable the thumbnail layout settings section.
      static java.lang.String FULL_SITE_SUPPORT
      Skins may set this boolean property to true to indicate that their skins supports the making of full web sites, and not just albums
      static java.lang.String FULL_VIDEO_SUPPORT
      Skins may set this boolean property to true to indicate that their skins supports the playing of the mp4 video files jAlbum generates since v11 Without this flag set to true, jAlbum may warn the user about lack of full video support when making albums that consists of videos
      static java.lang.String HOME_PAGE  
      static java.lang.String LAST_MODIFIED_DATE
      Format YYYY-MM-DD
      static java.lang.String MAKE_DEEP_JSON_DATA
      Control if to also create a deep-data.json page when creating json pages
      static java.lang.String MAKE_WEB_LOCATION_SLIDES
      Boolean (true/false) flag stating whether slide images and slide pages should be created for web locations or not Currently defaults to true.
      static java.lang.String PREVENT_COPY
      Skins may specify a comma separated list of skin variables that are to not be copied when importing settings from other album projects
      static java.lang.String REQUIRED_JALBUM_VERSION
      This setting is respected since jAlbum 8.7
      static java.lang.String REQUIRED_JAVA_VERSION  
      static java.lang.String SCRIPT_LANGUAGE
      Script language to use jAlbum automatically determines what script language to use by the extension of the init file (init.bsh -> BeanShell, init.js -> JavaScript) If no init file exists, then this property determines the language to use Allowed values: BEANSHELL and JAVASCRIPT
      static java.lang.String SEPARATE_DESCRIPTION
      Boolean (true/false) flag stating whether this skin supports folder descriptions different from folder comments Defaults to false
      static java.lang.String SEPARATE_THEME_IMAGE
      Boolean (true/false) flag stating whether this skin supports a theme image that is separate from the folder thumbnail.
      static java.lang.String SKIN_FAMILY
      Family this skin belongs to.
      static java.lang.String SKIN_MODEL
      Fully qualified (including packages) class name of skin model.
      static java.lang.String SLIDE_MODEL
      Fully qualified (including packages) class name of slide model.
      static java.lang.String SUPPORT_FORUM  
      static java.lang.String THEME_IMAGE_SIZE_NAME
      Name of variable to represent the size of the theme image.
      static java.lang.String TITLE
      Alternative name for skin.
      static java.lang.String TRUE_ORIGINAL_PATH
      Tell jAlbum to use originalPath for true original images only, and not also to link to hi-res images.
      static java.lang.String USERNAME  
      static java.lang.String VERSION
      Skin version.
    • Constructor Summary

      Constructors 
      Constructor Description
      SkinProperties​(java.io.File skinDir)  
    • Field Detail

      • TITLE

        public static final java.lang.String TITLE
        Alternative name for skin.
        See Also:
        Constant Field Values
      • VERSION

        public static final java.lang.String VERSION
        Skin version. Format xx.yy or xx.yy.zz
        See Also:
        Constant Field Values
      • CREATION_DATE

        public static final java.lang.String CREATION_DATE
        Format YYYY-MM-DD
        See Also:
        Constant Field Values
      • LAST_MODIFIED_DATE

        public static final java.lang.String LAST_MODIFIED_DATE
        Format YYYY-MM-DD
        See Also:
        Constant Field Values
      • REQUIRED_JALBUM_VERSION

        public static final java.lang.String REQUIRED_JALBUM_VERSION
        This setting is respected since jAlbum 8.7
        See Also:
        Constant Field Values
      • REQUIRED_JAVA_VERSION

        public static final java.lang.String REQUIRED_JAVA_VERSION
        See Also:
        Constant Field Values
      • AUTO_WIDGET_INJECTION

        public static final java.lang.String AUTO_WIDGET_INJECTION
        Tell if jAlbum is to automatically inject Widget loader code into generate pages (done manually with the <ja:widget> tag) Valid values are true and false. Defaults to true
        See Also:
        Constant Field Values
      • ENABLE_THUMBNAIL_LAYOUT

        public static final java.lang.String ENABLE_THUMBNAIL_LAYOUT
        Tell jAlbum to use enable or disable the thumbnail layout settings section. Skins that ignores thumbnail layout can set this to false to indicate to the user that thumbnail layout is ignored. Defaults to true
        Since:
        11.5
        See Also:
        Constant Field Values
      • TRUE_ORIGINAL_PATH

        public static final java.lang.String TRUE_ORIGINAL_PATH
        Tell jAlbum to use originalPath for true original images only, and not also to link to hi-res images. Defaults to true. Set to false if you wish jAlbum to map originalPath to hi-res images when originals are not available, but hi-res are.
        Since:
        8.14
        See Also:
        Constant Field Values
      • COMPATIBILITY_MODE

        public static final java.lang.String COMPATIBILITY_MODE
        Skins that rely on the deprecated "fileVariables" object can set this flag to true in order to still work with jALbum 10.3 and up The fileVariables object is a memory eater so please rewrite your skins to avoid its use. Use the new "currentObject", "currentFolder" and "rootFolder" objcts instead.
        Since:
        10.3
        See Also:
        Constant Field Values
      • FULL_SITE_SUPPORT

        public static final java.lang.String FULL_SITE_SUPPORT
        Skins may set this boolean property to true to indicate that their skins supports the making of full web sites, and not just albums
        See Also:
        Constant Field Values
      • PREVENT_COPY

        public static final java.lang.String PREVENT_COPY
        Skins may specify a comma separated list of skin variables that are to not be copied when importing settings from other album projects
        See Also:
        Constant Field Values
      • FULL_VIDEO_SUPPORT

        public static final java.lang.String FULL_VIDEO_SUPPORT
        Skins may set this boolean property to true to indicate that their skins supports the playing of the mp4 video files jAlbum generates since v11 Without this flag set to true, jAlbum may warn the user about lack of full video support when making albums that consists of videos
        See Also:
        Constant Field Values
      • SCRIPT_LANGUAGE

        public static final java.lang.String SCRIPT_LANGUAGE
        Script language to use jAlbum automatically determines what script language to use by the extension of the init file (init.bsh -> BeanShell, init.js -> JavaScript) If no init file exists, then this property determines the language to use Allowed values: BEANSHELL and JAVASCRIPT
        See Also:
        Constant Field Values
      • SKIN_MODEL

        public static final java.lang.String SKIN_MODEL
        Fully qualified (including packages) class name of skin model. Defaults to "SkinModel" in the default package
        Since:
        12.7.2
        See Also:
        Constant Field Values
      • SLIDE_MODEL

        public static final java.lang.String SLIDE_MODEL
        Fully qualified (including packages) class name of slide model. Defaults to "SlideModel" in the default package
        Since:
        12.7.2
        See Also:
        Constant Field Values
      • SKIN_FAMILY

        public static final java.lang.String SKIN_FAMILY
        Family this skin belongs to. Defaults to name of skin if not specified. Skins belonging to the same family share the same project settings when moving from one skin to another, otherwise the default settings are loaded
        Since:
        14
        See Also:
        Constant Field Values
      • MAKE_WEB_LOCATION_SLIDES

        public static final java.lang.String MAKE_WEB_LOCATION_SLIDES
        Boolean (true/false) flag stating whether slide images and slide pages should be created for web locations or not Currently defaults to true. If your skin cares, set this setting explicitly
        Since:
        14
        See Also:
        Constant Field Values
      • THEME_IMAGE_SIZE_NAME

        public static final java.lang.String THEME_IMAGE_SIZE_NAME
        Name of variable to represent the size of the theme image. The variable has to be delivered from the skin's user interface or skin model The presence of a theme image size variable triggers the visibility of the crop focus selector of jAlbum's folder property panel The data type of the variable should be String. The value should be in the format "width x height" Defaults to "folderImageSize"
        Since:
        15
        See Also:
        Constant Field Values
      • SEPARATE_THEME_IMAGE

        public static final java.lang.String SEPARATE_THEME_IMAGE
        Boolean (true/false) flag stating whether this skin supports a theme image that is separate from the folder thumbnail. Defaults to false
        Since:
        15
        See Also:
        Constant Field Values
      • EDITABLE_THEME_IMAGE_SIZE

        public static final java.lang.String EDITABLE_THEME_IMAGE_SIZE
        Boolean (true/false) flag stating whether this skin allows the user to edit the theme image size and crop region through the theme image selector of the folder property panel. Defaults to false. If true, the skin's own themeImageSize variable is ignored.
        Since:
        16
        See Also:
        Constant Field Values
      • SEPARATE_DESCRIPTION

        public static final java.lang.String SEPARATE_DESCRIPTION
        Boolean (true/false) flag stating whether this skin supports folder descriptions different from folder comments Defaults to false
        Since:
        15.3
        See Also:
        Constant Field Values
      • MAKE_DEEP_JSON_DATA

        public static final java.lang.String MAKE_DEEP_JSON_DATA
        Control if to also create a deep-data.json page when creating json pages
        See Also:
        Constant Field Values
    • Constructor Detail

      • SkinProperties

        public SkinProperties​(java.io.File skinDir)
    • Method Detail

      • save

        public void save()
                  throws java.io.IOException
        Throws:
        java.io.IOException
        Since:
        8.7
      • getProperty

        public java.lang.String getProperty​(java.lang.String key)
        Since:
        8.5
      • getProperty

        public java.lang.String getProperty​(java.lang.String key,
                                            java.lang.String def)
        Since:
        8.7
      • getProperties

        public java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Since:
        8.7
      • getRepositoryProperties

        public SkinProperties.RepositoryProperties getRepositoryProperties()
                                                                    throws java.io.IOException
        Get the corresponding properties for this skin in our skin repository
        Returns:
        Throws:
        java.io.IOException
        Since:
        v11
      • setProperty

        public void setProperty​(java.lang.String key,
                                java.lang.String value)
        Since:
        8.7
      • isCompatibilityMode

        public boolean isCompatibilityMode()
      • isAutoWidgetInjection

        public boolean isAutoWidgetInjection()
      • isEnableThumbnailLayout

        public boolean isEnableThumbnailLayout()
      • isTrueOriginalPath

        public boolean isTrueOriginalPath()
      • getThemeImageSizeName

        public java.lang.String getThemeImageSizeName()
      • isSeparateThemeImage

        public boolean isSeparateThemeImage()
      • isEditableThemeImageSize

        public boolean isEditableThemeImageSize()
      • isMakeWebLocationSlides

        public boolean isMakeWebLocationSlides()
      • isSeparateDescription

        public boolean isSeparateDescription()
      • isMakeDeepJSONData

        public boolean isMakeDeepJSONData()