diff options
Diffstat (limited to 'src/com/itmill/toolkit/terminal/web/ThemeSource.java')
-rw-r--r-- | src/com/itmill/toolkit/terminal/web/ThemeSource.java | 183 |
1 files changed, 0 insertions, 183 deletions
diff --git a/src/com/itmill/toolkit/terminal/web/ThemeSource.java b/src/com/itmill/toolkit/terminal/web/ThemeSource.java deleted file mode 100644 index c2ff054683..0000000000 --- a/src/com/itmill/toolkit/terminal/web/ThemeSource.java +++ /dev/null @@ -1,183 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.InputStream; -import java.util.Collection; - -/** - * Interface implemented by theme sources. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public interface ThemeSource { - - /** - * Gets the name of the ThemeSource. - * - * @return the Name of the theme source. - */ - public String getName(); - - /** - * Gets the XSL stream for the specified theme and web-browser type. Returns - * the XSL templates, which are used to process the UIDL data. The - * <code>type</code> parameter is used to limit the templates, which are - * returned based on the theme fileset requirements. - * <p> - * Note : This implicitly operates in xslt mode. - * </p> - * - * @param theme - * the Theme, which XSL should be returned. - * @param type - * the type of the current client. - * @return Collection of ThemeSource.XSLStream objects. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - * @see Theme - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException; - - /** - * Gets the last modification time, used to reload theme on changes. - * - * @return the Last modification time of the theme source. - */ - public long getModificationTime(); - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @param resourceId - * the resource id. - * @return Stream where the resource can be read. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - */ - public InputStream getResource(String resourceId) throws ThemeException; - - /** - * Gets the list of themes in the theme source. - * - * @return the List of themes included in the theme source. - */ - public Collection getThemes(); - - /** - * Returns the Theme instance by name. - * - * @param name - * the Theme name. - * @return the Theme instance matching the name, or null if not found. - */ - public Theme getThemeByName(String name); - - /** - * <code>ThemeException</code> is thrown by classes implementing the - * <code>ThemeSource</code> interface if some error occurs during - * processing. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class ThemeException extends Exception { - - private static final long serialVersionUID = -7823850742197580285L; - - /** - * Creates a new theme exception. - * - * @param message - * the Error message. - */ - public ThemeException(String message) { - super(message); - } - - /** - * Creates a new theme exception. - * - * @param message - * the error message. - * @param cause - * the cause of the exception. - */ - public ThemeException(String message, Throwable cause) { - super(message, cause); - } - } - - /** - * Wrapper class for XSL InputStreams. - */ - public class XSLStream { - private String id; - - private InputStream stream; - - /** - * - * @param id - * @param stream - * the input stream. - */ - public XSLStream(String id, InputStream stream) { - this.id = id; - this.stream = stream; - } - - /** - * Returns id of this stream. - * - * @return the id of the stream. - */ - public String getId() { - return id; - } - - /** - * Returns the actual XSL Stream. - * - * @return the XSL Stream. - */ - public InputStream getStream() { - return stream; - } - - } -} |