public class TurbineUI extends Object
UIService
should ALWAYS be accessed via
either this class or UITool
.Constructor and Description |
---|
TurbineUI() |
Modifier and Type | Method and Description |
---|---|
static String |
get(String key)
Retrieve a skin property from the default skin for the webapp.
|
static String |
get(String skinName,
String key)
Retrieve a skin property from the named skin.
|
static String |
getScript(String skinName,
String filename)
Retrieve the URL for a given script that is part of the skin.
|
static String |
getScript(String skinName,
String filename,
ServerData serverData)
Retrieve the URL for a given script that is part of the skin.
|
protected static UIService |
getService()
Get the service instance
|
static String[] |
getSkinNames()
Provide access to the list of available skin names.
|
static String |
getStylecss(String skinName)
Retrieve the URL for the style sheet that is part of a skin.
|
static String |
getStylecss(String skinName,
ServerData serverData)
Retrieve the URL for the style sheet that is part of a skin.
|
static String |
getWebappSkinName()
Get the name of the default skin name for the web application from the
TurbineResources.properties file.
|
static String |
image(String skinName,
String imageId)
Retrieve the URL for an image that is part of a skin.
|
static String |
image(String skinName,
String imageId,
ServerData serverData)
Retrieve the URL for an image that is part of a skin.
|
static void |
refresh()
Refresh all skins.
|
static void |
refresh(String skinName)
Refresh a particular skin.
|
public TurbineUI()
public static void refresh()
protected static UIService getService()
UIService
instancepublic static void refresh(String skinName)
skinName
- the name of the skin to clear.public static String[] getSkinNames()
public static String getWebappSkinName()
public static String get(String skinName, String key)
null
will be returned.skinName
- the name of the skin to retrieve the property from.key
- the key to retrieve from the skin.null
,
depending on whether or not the property or skins exist.public static String get(String key)
null
will be returned.key
- the key to retrieve.null
, depending on
whether or not the property or skins exist.public static String image(String skinName, String imageId, ServerData serverData)
Use this if for some reason your server name, server scheme, or server port change on a per request basis. I'm not sure if this would happen in a load balanced situation. I think in most cases the image(String image) method would probably be enough, but I'm not absolutely positive.
skinName
- the name of the skin to retrieve the image from.imageId
- the id of the image whose URL will be generated.serverData
- the ServerData to use as
the basis for the URL.public static String image(String skinName, String imageId)
skinName
- the name of the skin to retrieve the image from.imageId
- the id of the image whose URL will be generated.public static String getStylecss(String skinName, ServerData serverData)
Use this if for some reason your server name, server scheme, or server port change on a per request basis. I'm not sure if this would happen in a load balanced situation. I think in most cases the style() method would probably be enough, but I'm not absolutely positive.
skinName
- the name of the skin to retrieve the style sheet from.serverData
- the ServerData to use as
the basis for the URL.public static String getStylecss(String skinName)
skinName
- the name of the skin to retrieve the style sheet from.public static String getScript(String skinName, String filename, ServerData serverData)
Use this if for some reason your server name, server scheme, or server port change on a per request basis. I'm not sure if this would happen in a load balanced situation. I think in most cases the image(String image) method would probably be enough, but I'm not absolutely positive.
skinName
- the name of the skin to retrieve the image from.filename
- the name of the script file whose URL will be generated.serverData
- the ServerData to use as
the basis for the URL.public static String getScript(String skinName, String filename)
skinName
- the name of the skin to retrieve the image from.filename
- the name of the script file whose URL will be generated.Copyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.