Package se.datadosen.jalbum

Class SkinProperties

java.lang.Object
se.datadosen.jalbum.SkinProperties
public class SkinProperties extends Object
Representation of the (optional) skin.properties file of skins

  • Field Details

    • TITLE

      public static final String TITLE
      Alternative name for skin.
      See Also:

    • AUTHOR

      public static final String AUTHOR
      See Also:

    • USERNAME

      public static final String USERNAME
      See Also:

    • COMPANY

      public static final String COMPANY
      See Also:

    • VERSION

      public static final String VERSION
      Skin version. Format xx.yy or xx.yy.zz
      See Also:

    • CREATION_DATE

      public static final String CREATION_DATE
      Format YYYY-MM-DD
      See Also:

    • LAST_MODIFIED_DATE

      public static final String LAST_MODIFIED_DATE
      Format YYYY-MM-DD
      See Also:

    • DESCRIPTION

      public static final String DESCRIPTION
      See Also:

    • HOME_PAGE

      public static final String HOME_PAGE
      See Also:

    • SUPPORT_FORUM

      public static final String SUPPORT_FORUM
      See Also:

    • REQUIRED_JALBUM_VERSION

      public static final String REQUIRED_JALBUM_VERSION
      This setting is respected since jAlbum 8.7
      See Also:

    • AUTO_WIDGET_INJECTION

      public static final 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:

    • ENABLE_THUMBNAIL_LAYOUT

      public static final 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:

    • FULL_SITE_SUPPORT

      public static final 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:

    • PREVENT_COPY

      public static final 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:

    • FULL_VIDEO_SUPPORT

      public static final 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:

    • SCRIPT_LANGUAGE

      public static final 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:

    • SKIN_MODEL

      public static final 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:

    • SLIDE_MODEL

      public static final 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:

    • PRESERVE_VARIABLES

      public static final String PRESERVE_VARIABLES
      Comma separated list of variables to preserve when loading this skin
      Since:
      21.1
      See Also:

    • SKIN_FAMILY

      public static final 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:

    • MAKE_WEB_LOCATION_SLIDES

      public static final 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:

    • THEME_IMAGE_SIZE_NAME

      public static final 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:

    • SEPARATE_THEME_IMAGE

      public static final 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:

    • EDITABLE_THEME_IMAGE_SIZE

      public static final 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:

    • SEPARATE_DESCRIPTION

      public static final 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:

    • MAKE_DEEP_JSON_DATA

      public static final String MAKE_DEEP_JSON_DATA
      Control if to also create a deep-data.json page when creating json pages
      See Also:

    • SUPPORTS_VARIANTS

      public static final String SUPPORTS_VARIANTS
      Set to true if skin supports image variants (Activates the Variants editor under Settings-Images)
      See Also:

    • SUPPORTS_FOLDER_THUMBS

      public static final String SUPPORTS_FOLDER_THUMBS
      Boolean (true/false) flag stating whether this skin supports unique folder thumbnail image sizes. Defaults to false
      Since:
      27
      See Also:

    • DISABLED_CONTROLS

      public static final String DISABLED_CONTROLS
      Comma separated list of variables referring to UI controls to disable
      Since:
      27.1
      See Also:

    • CLEAN_RES_FOLDER

      public static final String CLEAN_RES_FOLDER
      Whether the res folder should be cleaned on each album build
      See Also:

    • ICON

      public static final String ICON
      Path to icon to appear in skin settings tab, relative to skin UI code.
      Since:
      32
      See Also:

    • SINGLE_INDEX_PAGE

      public static final String SINGLE_INDEX_PAGE
      Generate one single index page, no matter the "rows" and "cols" settings
      Since:
      33
      See Also:

    • MAIN_CLASS

      public static final String MAIN_CLASS
      Fully qualified class name of class to load on load May extend CompiledBase or be an instance of JAlbumPlugin
      Since:
      33
      See Also:

  • Constructor Details

    • SkinProperties

      public SkinProperties(File skinDir)

  • Method Details

    • save

      public void save() throws IOException
      Throws:
      IOException
      Since:
      8.7

    • getProperty

      public String getProperty(String key)
      Since:
      8.5

    • getProperty

      public String getProperty(String key, String def)
      Since:
      8.7

    • getProperties

      public Map<String,String> getProperties()
      Since:
      8.7

    • getRepositoryProperties

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

    • setProperty

      public void setProperty(String key, String value)
      Since:
      8.7

    • isAutoWidgetInjection

      public boolean isAutoWidgetInjection()

    • isEnableThumbnailLayout

      public boolean isEnableThumbnailLayout()

    • isFullSiteSupport

      public boolean isFullSiteSupport()

    • isSet

      public boolean isSet(String key)
      Parameters:
      key -
      Returns:
      Since:
      29.2

    • getThemeImageSizeName

      public String getThemeImageSizeName()

    • isSeparateThemeImage

      public boolean isSeparateThemeImage()

    • isEditableThemeImageSize

      public boolean isEditableThemeImageSize()

    • isMakeWebLocationSlides

      public boolean isMakeWebLocationSlides()

    • isSeparateDescription

      public boolean isSeparateDescription()

    • isMakeDeepJSONData

      public boolean isMakeDeepJSONData()

    • isSupportsVariants

      public boolean isSupportsVariants()

    • getVersion

      public VersionNumber getVersion()