| org.apache.turbine.services.ui.UIService
All known Subclasses: org.apache.turbine.services.ui.TurbineUIService,
| UIService | | public interface UIService extends Service(Code) | | The UI service provides for shared access to User Interface (skin) files,
as well as the ability for non-default skin files to inherit properties from
a default skin. Use TurbineUI to access skin properties from your screen
classes and action code. UITool is provided as a pull tool for accessing
skin properties from your templates.
Skins are lazy loaded in that they are not loaded until first used.
author:
Scott Eade
version:
$Id$
See Also: UIService
See Also: UITool |
| SERVICE_NAME | | public String SERVICE_NAME(Code) | | The service identifier.
|
| get | | public String get(String skinName, String key)(Code) | | Retrieve a skin property from the named skin. If the property is not
defined in the named skin the value for the default skin will be
provided. If the named skin does not exist then the skin configured for
the webapp will be used. If the webapp skin does not exist the default
skin will be used. If the default skin does not exist then
null will be returned.
Parameters:
skinName - the name of the skin to retrieve the property from.
Parameters:
key - the key to retrieve from the skin. the value of the property for the named skin (defaulting to the default skin), the webapp skin, the default skin or null,depending on whether or not the property or skins exist. |
| get | | public String get(String key)(Code) | | Retrieve a skin property from the default skin for the webapp. If the
property is not defined in the webapp skin the value for the default skin
will be provided. If the webapp skin does not exist the default skin
will be used. If the default skin does not exist then null
will be returned.
Parameters:
key - the key to retrieve. the value of the property for the webapp skin (defaulting to the default skin), the default skin or null, depending on whether or not the property or skins exist. |
| getScript | | public String getScript(String skinName, String filename, ServerData serverData)(Code) | | Retrieve the URL for a given script that is part of a skin. The script is
stored in the WEBAPP/resources/ui/skins/[SKIN] directory.
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.
Parameters:
skinName - the name of the skin to retrieve the image from.
Parameters:
filename - the name of the script file.
Parameters:
serverData - the serverData to use as the basis for the URL. |
| getScript | | public String getScript(String skinName, String filename)(Code) | | Retrieve the URL for a given script that is part of a skin. The script is
stored in the WEBAPP/resources/ui/skins/[SKIN] directory.
Parameters:
skinName - the name of the skin to retrieve the image from.
Parameters:
filename - the name of the script file. |
| getSkinNames | | public String[] getSkinNames()(Code) | | Provide access to the list of available skin names.
the available skin names. |
| getStylecss | | public String getStylecss(String skinName, ServerData serverData)(Code) | | Retrieve the URL for the style sheet that is part of a skin. The style is
stored in the WEBAPP/resources/ui/skins/[SKIN] directory with the
filename skin.css
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.
Parameters:
skinName - the name of the skin to retrieve the style sheet from.
Parameters:
serverData - the serverData to use as the basis for the URL. |
| getStylecss | | public String getStylecss(String skinName)(Code) | | Retrieve the URL for the style sheet that is part of a skin. The style is
stored in the WEBAPP/resources/ui/skins/[SKIN] directory with the
filename skin.css
Parameters:
skinName - the name of the skin to retrieve the style sheet from. |
| getWebappSkinName | | public String getWebappSkinName()(Code) | | Get the name of the default skin name for the web application from the
TurbineResources.properties file. If the property is not present the
name of the default skin will be returned. Note that the web application
skin name may be something other than default, in which case its
properties will default to the skin with the name "default".
the name of the default skin for the web application. |
| image | | public String image(String skinName, String imageId, ServerData serverData)(Code) | | Retrieve the URL for an image that is part of a skin. The images are
stored in the WEBAPP/resources/ui/skins/[SKIN]/images directory.
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.
Parameters:
skinName - the name of the skin to retrieve the image from.
Parameters:
imageId - the id of the image whose URL will be generated.
Parameters:
serverData - the serverData to use as the basis for the URL. |
| image | | public String image(String skinName, String imageId)(Code) | | Retrieve the URL for an image that is part of a skin. The images are
stored in the WEBAPP/resources/ui/skins/[SKIN]/images directory.
Parameters:
skinName - the name of the skin to retrieve the image from.
Parameters:
imageId - the id of the image whose URL will be generated. |
| refresh | | public void refresh()(Code) | | Refresh all skins.
|
| refresh | | public void refresh(String skinName)(Code) | | Refresh a particular skin.
Parameters:
skinName - the name of the skin to clear. |
|
|