se.datadosen.jalbum
Class SkinProperties

java.lang.Object
  extended by se.datadosen.jalbum.SkinProperties

public class SkinProperties
extends java.lang.Object

Representation of the (optional) skin.properties file of skins


Field Summary
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 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 HOME_PAGE
           
static java.lang.String LAST_MODIFIED_DATE
          Format YYYY-MM-DD
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 SUPPORT_FORUM
           
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
SkinProperties(java.io.File skinDir)
           
 
Method Summary
 java.util.Map<java.lang.String,java.lang.String> getProperties()
           
 java.lang.String getProperty(java.lang.String key)
           
 java.lang.String getProperty(java.lang.String key, java.lang.String def)
           
 boolean isAutoWidgetInjection()
           
 boolean isCompatilibityMode()
           
 boolean isTrueOriginalPath()
           
 void save()
           
 void setProperty(java.lang.String key, java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TITLE

public static final java.lang.String TITLE
Alternative name for skin.

See Also:
Constant Field Values

AUTHOR

public static final java.lang.String AUTHOR
See Also:
Constant Field Values

USERNAME

public static final java.lang.String USERNAME
See Also:
Constant Field Values

COMPANY

public static final java.lang.String COMPANY
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

DESCRIPTION

public static final java.lang.String DESCRIPTION
See Also:
Constant Field Values

HOME_PAGE

public static final java.lang.String HOME_PAGE
See Also:
Constant Field Values

SUPPORT_FORUM

public static final java.lang.String SUPPORT_FORUM
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 tag) Valid values are true and false. Defaults to true

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
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

setProperty

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

isCompatilibityMode

public boolean isCompatilibityMode()

isAutoWidgetInjection

public boolean isAutoWidgetInjection()

isTrueOriginalPath

public boolean isTrueOriginalPath()