summaryrefslogtreecommitdiff
path: root/src/plugins/emulator/src/com/motorola/studio/android/emulator/skin/android/parser/PartBean.java
blob: 3a2625f5e1cbb51a908f6e3ad342ee1063c3ce4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.motorola.studio.android.emulator.skin.android.parser;

import java.util.Collection;
import java.util.LinkedHashSet;

/**
 * DESCRIPTION:
 * This class represents a part structure from the layout file
 *
 * RESPONSIBILITY:
 * Represent part structures
 *
 * COLABORATORS:
 * None.
 *
 * USAGE:
 * This class is intended to be used by the LayoutFileParser and LayoutFileModel classes only
 */
public class PartBean
{
    /**
     * The string used as name of a part, at skins that have a single part 
     */
    public static final String UNIQUE_PART = "___UNIQUE___";

    /**
     * The part name
     */
    private String name;

    /**
     * The part background data
     */
    private ImagePositionBean background;

    /**
     * The part display data
     */
    private RectangleBean display;

    /**
     * The part buttons
     */
    private Collection<ImagePositionBean> buttons = new LinkedHashSet<ImagePositionBean>();

    /**
     * Constructor
     * Builds a new part structure with the given name
     * 
     * @param name The layout name
     */
    PartBean(String name)
    {
        this.name = name;
    }

    /**
     * Creates a new button, registers it and returns it to the user
     * 
     * @param buttonName The name to assign to the button
     * 
     * @return The button
     */
    ImagePositionBean newButton(String buttonName)
    {
        ImagePositionBean bean = new ImagePositionBean(buttonName);
        buttons.add(bean);
        return bean;
    }

    /**
     * Creates a new display and registers it
     * 
     * @return The display
     */
    RectangleBean newDisplay()
    {
        display = new RectangleBean();
        return display;
    }

    /**
     * Creates a new background and registers it
     * 
     * @param bgName The name of the background image
     * 
     * @return The background
     */
    ImagePositionBean newBackground(String bgName)
    {
        background = new ImagePositionBean(bgName);
        return background;
    }

    /**
     * Retrieves the part background information 
     * 
     * @return The part background information
     */
    ImagePositionBean getBackground()
    {
        return background;
    }

    /**
     * Retrieves the part display information
     * 
     * @return The part display information
     */
    RectangleBean getDisplay()
    {
        return display;
    }

    /**
     * Retrieves the part name
     * 
     * @return The part name
     */
    String getName()
    {
        return name;
    }

    Collection<ImagePositionBean> getButtons()
    {
        return buttons;
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString()
    {
        return "Part: " + name;
    }
}