CmsLabel


1   /*
2   * File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsLabel.java,v $
3   * Date   : $Date: 2005/06/27 23:22:07 $
4   * Version: $Revision: 1.2 $
5   *
6   * This library is part of OpenCms -
7   * the Open Source Content Mananagement System
8   *
9   * Copyright (C) 2001  The OpenCms Group
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about OpenCms, please see the
22  * OpenCms Website: http://www.opencms.org 
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28  
29  
30  package com.opencms.workplace;
31  
32  import org.opencms.file.CmsObject;
33  import org.opencms.main.CmsException;
34  
35  import com.opencms.template.A_CmsXmlContent;
36  
37  import java.util.Hashtable  ;
38  
39  import org.w3c.dom.Element  ;
40  
41  /**
42   * Class for building workplace labels. <BR>
43   * Called by CmsXmlTemplateFile for handling the special XML tag <code>&lt;LABEL&gt;</code>.
44   * 
45   * @author Michael Emmerich
46   * @version $Revision: 1.2 $ $Date: 2005/06/27 23:22:07 $
47   * 
48   * @deprecated Will not be supported past the OpenCms 6 release.
49   */
50  
51  public class CmsLabel extends A_CmsWpElement {
52      
53      /**
54       * Handling of the <CODE>&lt;LABEL&gt;</CODE> tags.
55       * <P>
56       * Reads the code of a label from the label definition file
57       * and returns the processed code with the actual elements.
58       * <P>
59       * Labels can be referenced in any workplace template by <br>
60       * <CODE>&lt;LABEL name="..." action="..." alt="..."/&gt;</CODE>
61       * 
62       * @param cms CmsObject Object for accessing resources.
63       * @param n XML element containing the <code>&lt;LABEL&gt;</code> tag.
64       * @param doc Reference to the A_CmsXmlContent object of the initiating XLM document.  
65       * @param callingObject reference to the calling object.
66       * @param parameters Hashtable containing all user parameters.
67       * @param lang CmsXmlLanguageFile conataining the currently valid language file.
68       * @return Processed button.
69       * @throws CmsException
70       */
71      
72      public Object   handleSpecialWorkplaceTag(CmsObject cms, Element   n, A_CmsXmlContent doc, 
73              Object   callingObject, Hashtable   parameters, CmsXmlLanguageFile lang) throws CmsException {
74          String   labelValue = n.getAttribute(CmsWorkplaceDefault.C_LABEL_VALUE);
75          String   outputValue = null;
76          String   result = "+++missing+++";
77          if(labelValue != null) {
78              CmsXmlWpLabelDefFile labeldef = getLabelDefinitions(cms);
79              outputValue = lang.getLanguageValue(labelValue);
80              result = labeldef.getLabel(outputValue);
81          }
82          return result;
83      }
84  }
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags