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
155
156
157
158
159
160
161
|
/*
* Copyright (C) 2010 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.android.ide.common.rendering.api;
import static com.android.ide.common.rendering.api.Result.Status.NOT_IMPLEMENTED;
import com.android.ide.common.rendering.api.Result.Status;
import java.awt.image.BufferedImage;
import java.io.File;
import java.util.EnumSet;
import java.util.Map;
/**
* Entry point of the Layout Library. Extensions of this class provide a method to compute
* and render a layout.
*/
public abstract class Bridge {
public final static int API_CURRENT = 8;
/**
* Returns the API level of the layout library.
* <p/>
* While no methods will ever be removed, some may become deprecated, and some new ones
* will appear.
* <p/>All Layout libraries based on {@link Bridge} return at minimum an API level of 5.
*/
public abstract int getApiLevel();
/**
* Returns the revision of the library inside a given (layoutlib) API level.
* The true revision number of the library is {@link #getApiLevel()}.{@link #getRevision()}
*/
public int getRevision() {
return 0;
}
/**
* Returns an {@link EnumSet} of the supported {@link Capability}.
* @return an {@link EnumSet} with the supported capabilities.
*
*/
public EnumSet<Capability> getCapabilities() {
return EnumSet.noneOf(Capability.class);
}
/**
* Initializes the Bridge object.
*
* @param platformProperties The build properties for the platform.
* @param fontLocation the location of the fonts.
* @param enumValueMap map attrName => { map enumFlagName => Integer value }. This is typically
* read from attrs.xml in the SDK target.
* @param log a {@link LayoutLog} object. Can be null.
* @return true if success.
*/
public boolean init(Map<String, String> platformProperties,
File fontLocation,
Map<String, Map<String, Integer>> enumValueMap,
LayoutLog log) {
return false;
}
/**
* Prepares the layoutlib to unloaded.
*/
public boolean dispose() {
return false;
}
/**
* Starts a layout session by inflating and rendering it. The method returns a
* {@link RenderSession} on which further actions can be taken.
*
* @return a new {@link RenderSession} object that contains the result of the scene creation and
* first rendering.
*/
public RenderSession createSession(SessionParams params) {
return null;
}
/**
* Renders a Drawable. If the rendering is successful, the result image is accessible through
* {@link Result#getData()}. It is of type {@link BufferedImage}
* @param params the rendering parameters.
* @return the result of the action.
*/
public Result renderDrawable(DrawableParams params) {
return Status.NOT_IMPLEMENTED.createResult();
}
/**
* Clears the resource cache for a specific project.
* <p/>This cache contains bitmaps and nine patches that are loaded from the disk and reused
* until this method is called.
* <p/>The cache is not configuration dependent and should only be cleared when a
* resource changes (at this time only bitmaps and 9 patches go into the cache).
* <p/>
* The project key provided must be similar to the one passed in {@link RenderParams}.
*
* @param projectKey the key for the project.
*/
public void clearCaches(Object projectKey) {
}
/**
* Utility method returning the parent of a given view object.
*
* @param viewObject the object for which to return the parent.
*
* @return a {@link Result} indicating the status of the action, and if success, the parent
* object in {@link Result#getData()}
*/
public Result getViewParent(Object viewObject) {
return NOT_IMPLEMENTED.createResult();
}
/**
* Utility method returning the index of a given view in its parent.
* @param viewObject the object for which to return the index.
*
* @return a {@link Result} indicating the status of the action, and if success, the index in
* the parent in {@link Result#getData()}
*/
public Result getViewIndex(Object viewObject) {
return NOT_IMPLEMENTED.createResult();
}
/**
* Utility method returning the baseline value for a given view object. This basically returns
* View.getBaseline().
*
* @param viewObject the object for which to return the index.
*
* @return the baseline value or -1 if not applicable to the view object or if this layout
* library does not implement this method.
*
* @deprecated use the extended ViewInfo.
*/
@Deprecated
public Result getViewBaseline(Object viewObject) {
return NOT_IMPLEMENTED.createResult();
}
}
|
