1 /**
2 * This file Copyright (c) 2015 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.templating.models.components;
35
36 import info.magnolia.dam.templating.functions.DamTemplatingFunctions;
37 import info.magnolia.jcr.util.PropertyUtil;
38 import info.magnolia.rendering.model.RenderingModel;
39 import info.magnolia.rendering.template.RenderableDefinition;
40 import info.magnolia.templating.functions.TemplatingFunctions;
41
42 import javax.inject.Inject;
43 import javax.jcr.Node;
44
45 /**
46 * Abstract teaser model providing common functionality for teaser components.
47 *
48 * @param <RD> The renderable definition.
49 */
50
51 public abstract class AbstractTeaserModel<RD extends RenderableDefinition> extends ImageModel {
52
53 protected static final String PROPERTY_NAME_LINK = "link";
54 protected static final String PROPERTY_NAME_TEASER_TITLE = "teaserTitle";
55 protected static final String PROPERTY_NAME_TEASER_ABSTRACT = "teaserAbstract";
56 protected static final String PROPERTY_NAME_HIGHLIGHTED = "highlight";
57 protected static final String PROPERTY_NAME_HIDE_TEASER_IMAGE = "hideTeaserImage";
58
59 protected final TemplatingFunctions templatingFunctions;
60
61 @Inject
62 public AbstractTeaserModel(Node content, RD definition, RenderingModel<?> parent, TemplatingFunctions templatingFunctions, DamTemplatingFunctions damTemplatingFunctions) {
63 super(content, definition, parent, damTemplatingFunctions);
64
65 this.templatingFunctions = templatingFunctions;
66 }
67
68 /**
69 * Returns the title of the teaser.
70 */
71 public String getTeaserTitle() {
72 return PropertyUtil.getString(content, PROPERTY_NAME_TEASER_TITLE);
73 }
74
75 /**
76 * Returns the teaser text.
77 */
78 public String getTeaserText() {
79 return PropertyUtil.getString(content, PROPERTY_NAME_TEASER_ABSTRACT);
80 }
81
82 /**
83 * Returns whether the teaser should be highlighted or not.
84 */
85 public boolean isHighlighted() {
86 return PropertyUtil.getBoolean(content, PROPERTY_NAME_HIGHLIGHTED, false);
87 }
88
89 /**
90 * Returns whether the teaser image should be hidden or not.
91 *
92 * @see super#getImage()
93 */
94 public boolean isHideTeaserImage() {
95 return PropertyUtil.getBoolean(content, PROPERTY_NAME_HIDE_TEASER_IMAGE, false);
96 }
97
98 /**
99 * Returns the link to the teased item.
100 */
101 abstract public String getTeaserLink();
102
103 /**
104 * Returns whether the teaser link should open in a new window or not.
105 */
106 abstract public boolean isTargetBlank();
107
108 }