public class TurbineUIService extends TurbineBaseService implements UIService
UIService,
UITool| Modifier and Type | Field and Description |
|---|---|
static String |
SKIN_PROPERTY_DEFAULT
Default skin name.
|
configuration, name, serviceBrokerinitableBroker, isInitializedSERVICE_NAME| Constructor and Description |
|---|
TurbineUIService() |
| Modifier and Type | Method and Description |
|---|---|
String |
get(String key)
Retrieve a skin property from the default skin for the webapp.
|
String |
get(String skinName,
String key)
Retrieve a skin property from the named skin.
|
String |
getScript(String skinName,
String filename)
Retrieve the URL for a given script that is part of a skin.
|
String |
getScript(String skinName,
String filename,
ServerData serverData)
Retrieve the URL for a given script that is part of a skin.
|
String[] |
getSkinNames()
Provide access to the list of available skin names.
|
String |
getStylecss(String skinName)
Retrieve the URL for the style sheet that is part of a skin.
|
String |
getStylecss(String skinName,
ServerData serverData)
Retrieve the URL for the style sheet that is part of a skin.
|
String |
getWebappSkinName()
Get the name of the default skin name for the web application from the
TurbineResources.properties file.
|
String |
image(String skinName,
String imageId)
Retrieve the URL for an image that is part of a skin.
|
String |
image(String skinName,
String imageId,
ServerData serverData)
Retrieve the URL for an image that is part of a skin.
|
void |
init()
Initializes the service.
|
void |
refresh()
Refresh the service by clearing all skins.
|
void |
refresh(String skinName)
Refresh a particular skin by clearing it.
|
void |
shutdown()
Returns to uninitialized state.
|
init, initgetConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBrokergetInit, getInitableBroker, setInit, setInitableBrokerclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetConfiguration, getName, getProperties, setName, setServiceBrokergetInit, init, setInitableBrokerpublic static final String SKIN_PROPERTY_DEFAULT
public TurbineUIService()
public void refresh()
public String get(String skinName, String key)
null will be returned.get in interface UIServiceskinName - 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 String get(String key)
null
will be returned.public String[] getSkinNames()
getSkinNames in interface UIServicepublic String getWebappSkinName()
getWebappSkinName in interface UIServicepublic 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.
public String image(String skinName, String imageId)
public 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.
getStylecss in interface UIServiceskinName - the name of the skin to retrieve the style sheet from.serverData - the serverData to use as the basis for the URL.public String getStylecss(String skinName)
getStylecss in interface UIServiceskinName - the name of the skin to retrieve the style sheet from.public 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 style() method would probably be enough, but I'm not absolutely positive.
public String getScript(String skinName, String filename)
public void init() throws InitializationException
init in interface Initableinit in class TurbineBaseServiceInitializationException - Initialization of this
class was not successful.public void shutdown()
shutdown in interface Initableshutdown in class TurbineBaseServiceCopyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.