View Javadoc

1   /**
2    * This file Copyright (c) 2009-2012 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.templatingkit.style;
35  
36  import info.magnolia.module.templatingkit.imaging.ImagingSupport;
37  import info.magnolia.module.templatingkit.resources.Resource;
38  
39  import java.util.List;
40  
41  
42  /**
43   * Default interface defining a STK theme.
44   * A Theme contains List of:
45   * <ul>
46   * <li><b>cssFiles</b>. Cascading style sheets describe the presentation semantics (look and formatting) of an HTML document.
47   * This node links the theme to CSS files stored in the resources workspace.
48   * </li>
49   * <li><b>jsFiles</b>. JavaScript is responsible for client-side functionality such as teaser paging, AJAX,
50   * AdminCentral menu animations, trees, embedded video player, mouse wheel support,
51   * Google Analytics and much more. This node links the theme to JavaScript files stored in the resources workspace.
52   * </li>
53   * </ul>
54   * and a reference to:
55   * <ul>
56   * <li><b>imaging</b>. Registers and enables the appropriate imaging class.
57   * The classes registered in the Community and Enterprise editions differ as the
58   * Imaging module is included in the Extended Templating Kit bundle.
59   * </li>
60   * <li><b>bodyClassResolver</b>. Registers the class that determines the page layout variations.
61   * </li>
62   * </ul>
63   * @author pbracher
64   * @version $Id$
65   *
66   */
67  public interface Theme {
68      public String getName();
69  
70      public List<CssFile> getCssFiles();
71  
72      public List<Resource> getJsFiles();
73  
74      public BodyClassResolver getBodyClassResolver();
75  
76      public ImagingSupport getImaging();
77  
78  }