IDrawComponentDescriptor


1   /* *****************************************************************************
2    * NightLabs Editor2D - Graphical editor framework                             *
3    * Copyright (C) 2004-2005 NightLabs - http://NightLabs.org                    *
4    *                                                                             *
5    * This library is free software; you can redistribute it and/or               *
6    * modify it under the terms of the GNU Lesser General Public                  *
7    * License as published by the Free Software Foundation; either                *
8    * version 2.1 of the License, or (at your option) any later version.          *
9    *                                                                             *
10   * This library is distributed in the hope that it will be useful,             *
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of              *
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU           *
13   * Lesser General Public License for more details.                             *
14   *                                                                             *
15   * You should have received a copy of the GNU Lesser General Public            *
16   * License along with this library; if not, write to the                       *
17   *     Free Software Foundation, Inc.,                                         *
18   *     51 Franklin St, Fifth Floor,                                            *
19   *     Boston, MA  02110-1301  USA                                             *
20   *                                                                             *
21   * Or get it online :                                                          *
22   *     http://www.gnu.org/copyleft/lesser.html                                 *
23   *                                                                             *
24   *                                                                             *
25   ******************************************************************************/
26  package org.nightlabs.editor2d.viewer.descriptor;
27  
28  import java.util.Map  ;
29  
30  import org.nightlabs.editor2d.DrawComponent;
31  
32  /**
33   * Describes an DrawComponent by returning Properties as Map for a DrawComponent
34   * 
35   * @author Daniel.Mazurek <at> NightLabs <dot> de
36   *
37   */
38  public interface IDrawComponentDescriptor 
39  {
40      /**
41       * sets the DrawComponent to get descriptions from
42       * @param dc the DrawComponent to set
43       */
44      void setDrawComponent(DrawComponent dc);
45      
46      /**
47       * returns the described drawComponent
48       * @return the DrawComponent to get descriptions from 
49       */
50      DrawComponent getDrawComponent();
51      
52      /**
53       * returns a single String which contains all properties (key+value) separated by commas (,)
54       * in the same order as they have been added
55       *   
56       * @param linewrap, determines if the entries should be returned with a linewrap or not
57       * @see IDrawComponentDescriptor#getProperties()
58       * @see IDrawComponentDescriptor#addEntry(String, String)
59       * @return a single String contained all properties 
60       */
61      String   getEntriesAsString(boolean linewrap);
62      
63      /**
64       * key: property name
65       * value: property value
66       * 
67       * @see IDrawComponentDescriptor#addEntry(String, String)
68       * @return a Map containing all properties for the DrawComponent 
69       */
70      Map  <String  , String  > getProperties();
71      
72      /**
73       * adds a Property Entry to the Descriptor, every time the drawComponent
74       * is newly set, all values must be adapted
75       *   
76       * @param name the property name
77       * @param value the property value 
78       */
79      void addEntry(String   name, String   value);
80  }
81
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags