Debian Codegraph @

laf-widget/src/main/java/org/pushingpixels/lafwidget/animation/AnimationFacet.java

raw
1 /*
2 * Copyright (c) 2005-2010 Laf-Widget Kirill Grouchnikov. 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 Laf-Widget 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.pushingpixels.lafwidget.animation;
31
32 /**
33 * Animation facet.
34 *
35 * @author Kirill Grouchnikov.
36 */
37 public final class AnimationFacet {
38 /**
39 * Animation facet display name.
40 */
41 protected String displayName;
42
43 /**
44 * Creates a new animation facet.
45 *
46 * @param displayName
47 * Display name for the animation facet.
48 * @param isDefaultAllowed
49 * Indicates whether this animation facet is allowed by default.
50 */
51 public AnimationFacet(String displayName, boolean isDefaultAllowed) {
52 this.displayName = displayName;
53 if (isDefaultAllowed) {
54 AnimationConfigurationManager.getInstance().allowAnimations(this);
55 }
56 }
57
58 /**
59 * Arming a component.
60 */
61 public static final AnimationFacet ARM = new AnimationFacet(
62 "lafwidgets.core.arm", true);
63
64 /**
65 * Pressing a component.
66 */
67 public static final AnimationFacet PRESS = new AnimationFacet(
68 "lafwidgets.core.press", true);
69
70 /**
71 * Focusing a component.
72 */
73 public static final AnimationFacet FOCUS = new AnimationFacet(
74 "lafwidgets.core.focus", true);
75
76 /**
77 * <p>
78 * Focus loop animation. Disabled by default, use
79 * {@link AnimationConfigurationManager#allowAnimations(AnimationFacet)} to
80 * enable.
81 * </p>
82 *
83 * @since version 3.0
84 */
85 public static final AnimationFacet FOCUS_LOOP_ANIMATION = new AnimationFacet(
86 "lafwidgets.core.focusLoopAnimation", false);
87
88 /**
89 * Rollover a component.
90 */
91 public static final AnimationFacet ROLLOVER = new AnimationFacet(
92 "lafwidgets.core.rollover", true);
93
94 /**
95 * Selecting a component.
96 */
97 public static final AnimationFacet SELECTION = new AnimationFacet(
98 "lafwidgets.core.selection", true);
99
100 /**
101 * <i>Ghosting image</i> effects on button icons when the button is
102 * rolled-over. Disabled by default, use
103 * {@link AnimationConfigurationManager#allowAnimations(AnimationFacet)} to
104 * enable.
105 */
106 public static final AnimationFacet GHOSTING_ICON_ROLLOVER = new AnimationFacet(
107 "lafwidgets.core.ghosting.iconRollover", false);
108
109 /**
110 * <i>Ghosting image</i> effects on buttons when the button is pressed.
111 * Disabled by default, use
112 * {@link AnimationConfigurationManager#allowAnimations(AnimationFacet)} to
113 * enable.
114 */
115 public static final AnimationFacet GHOSTING_BUTTON_PRESS = new AnimationFacet(
116 "lafwidgets.core.ghosting.buttonPress", false);
117
118 /**
119 * Glow effect on icons when the relevant control is rolled over. Disabled
120 * by default, use
121 * {@link AnimationConfigurationManager#allowAnimations(AnimationFacet)} to
122 * enable.
123 */
124 public static final AnimationFacet ICON_GLOW = new AnimationFacet(
125 "lafwidgets.core.iconGlow", false);
126
127 /*
128 * (non-Javadoc)
129 *
130 * @see java.lang.Object#toString()
131 */
132 @Override
133 public String toString() {
134 return this.displayName;
135 }
136 }