1 /*
2 * Copyright (c) 2004-2005 by Michael Connor. All Rights Reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * o Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 *
10 * o Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * o Neither the name of FormLayoutBuilder or Michael Connor nor the names of
15 * its contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package org.mlc.swing.layout;
31
32 import java.awt.Component;
33 import java.util.List;
34 import java.util.Map;
35
36 /***
37 * All components that want to be included in the list of components that want
38 * to be part of the builder must implement this interface
39 *
40 * @author Michael Connor
41 */
42 public interface ComponentBuilder
43 {
44 /***
45 * Returns a list of properties that are appropriate for construction
46 */
47 public List<BeanProperty> getProperties();
48
49 /***
50 * Returns the appropriate declaration suitable for this component
51 */
52 public String getDeclaration(String name, Map<String, Object> properties);
53
54 /***
55 * Returns an instance of this object given the specified properties
56 */
57 public Component getInstance(Map<String, Object> properties) throws Exception;
58
59 public boolean isComponentALayoutContainer();
60
61 public ComponentDef getComponentDef(String name, Map<String, Object> properties);
62 }