01: /*
02: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
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 Substance Kirill Grouchnikov 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.jvnet.substance.utils;
31:
32: import org.jvnet.substance.theme.ThemeInfo;
33: import org.jvnet.substance.watermark.WatermarkInfo;
34:
35: /**
36: * Base interface for Substance traits info, like {@link ThemeInfo},
37: * {@link WatermarkInfo} etc.
38: *
39: * @author Kirill Grouchnikov
40: */
41: public interface SubstanceTraitInfo {
42: /**
43: * Returns the display name of the associated trait. This method is part of
44: * officially supported API.
45: *
46: * @return The display name of the associated trait.
47: */
48: public String getDisplayName();
49:
50: /**
51: * Returns the class name of the associated trait.
52: *
53: * @return The class name of the associated trait. This method is part of
54: * officially supported API.
55: */
56: public String getClassName();
57:
58: /**
59: * Returns indication whether the associated trait is default.
60: *
61: * @return <code>true</code> if the associated trait is default,
62: * <code>false</code> otherwise.
63: */
64: public boolean isDefault();
65:
66: /**
67: * Sets indication whether the associated trait is default.
68: *
69: * @param isDefault
70: * New indication whether the associated trait is default.
71: */
72: public void setDefault(boolean isDefault);
73: }
|