View Javadoc
1   /*
2    * Copyright (c) 2002-2020, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.document.service.attributes;
35  
36  import fr.paris.lutece.plugins.document.business.Document;
37  import fr.paris.lutece.plugins.document.business.attributes.DocumentAttribute;
38  
39  
40  /**
41   * Manager for Rich Text Atrribute
42   */
43  public class RichTextManager extends DefaultManager
44  {
45      private static final String TEMPLATE_CREATE_ATTRIBUTE = "admin/plugins/document/attributes/create_richtext.html";
46      private static final String TEMPLATE_MODIFY_ATTRIBUTE = "admin/plugins/document/attributes/modify_richtext.html";
47  
48      /**
49       * Gets the template to enter the attribute value
50       * @return The template to enter the attribute value
51       */
52      protected String getCreateTemplate(  )
53      {
54          return TEMPLATE_CREATE_ATTRIBUTE;
55      }
56  
57      /**
58       * Gets the template to modify the attribute value
59       * @return The template to modify the attribute value
60       */
61      protected String getModifyTemplate(  )
62      {
63          return TEMPLATE_MODIFY_ATTRIBUTE;
64      }
65  
66      /**
67       * Gets the template to enter the parameters of the attribute value
68       * @return The template to enter the parameters of the attribute value
69       */
70      protected String getCreateParametersTemplate(  )
71      {
72          return null;
73      }
74  
75      /**
76       * Gets the template to modify the parameters of the attribute value
77       * @return The template to modify the parameters of the attribute value
78       */
79      protected String getModifyParametersTemplate(  )
80      {
81          return null;
82      }
83  
84      /**
85       * Get the XML data corresponding to the attribute to build the document XML content
86       * @param document The document
87       * @param attribute  The attribute
88       * @return The XML value of the attribute
89       */
90      public String getAttributeXmlValue( Document document, DocumentAttribute attribute )
91      {
92          // Return cdata Value
93          return "<![CDATA[" + attribute.getTextValue(  ) + "]]>";
94      }
95  }