building patched layoutlib-api
[idea/adt-tools-base.git] / layoutlib-api / src / main / java / com / android / ide / common / rendering / api / Bridge.java
1 /*
2  * Copyright (C) 2010 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.android.ide.common.rendering.api;
18
19
20 import com.android.ide.common.rendering.api.Result.Status;
21
22 import java.awt.image.BufferedImage;
23 import java.io.File;
24 import java.util.EnumSet;
25 import java.util.Map;
26
27 import static com.android.ide.common.rendering.api.Result.Status.NOT_IMPLEMENTED;
28
29 /**
30  * Entry point of the Layout Library. Extensions of this class provide a method to compute
31  * and render a layout.
32  */
33 @SuppressWarnings({"MethodMayBeStatic", "UnusedDeclaration"})
34 public abstract class Bridge {
35
36     public static final int API_CURRENT = 17;
37
38     /**
39      * Returns the API level of the layout library.
40      * <p>
41      * While no methods will ever be removed, some may become deprecated, and some new ones
42      * will appear.
43      * <p>All Layout libraries based on {@link Bridge} return at minimum an API level of 5.
44      */
45     public abstract int getApiLevel();
46
47     /**
48      * Returns the revision of the library inside a given (layoutlib) API level.
49      * The true revision number of the library is {@link #getApiLevel()}.{@link #getRevision()}
50      */
51     @SuppressWarnings("JavaDoc")  // javadoc pointing to itself.
52     public int getRevision() {
53         return 0;
54     }
55
56     /**
57      * Returns an {@link EnumSet} of the supported {@link Capability}.
58      *
59      * @return an {@link EnumSet} with the supported capabilities.
60      *
61      * @deprecated use {@link #supports(int)}
62      */
63     @Deprecated
64     public EnumSet<Capability> getCapabilities() {
65         return EnumSet.noneOf(Capability.class);
66     }
67
68     /**
69      * Returns true if the layout library supports the given feature.
70      *
71      * @see com.android.ide.common.rendering.api.Features
72      */
73     public boolean supports(int feature) {
74         return false;
75     }
76
77     /**
78      * Initializes the Bridge object.
79      *
80      * @param platformProperties The build properties for the platform.
81      * @param fontLocation the location of the fonts.
82      * @param enumValueMap map attrName ⇒ { map enumFlagName ⇒ Integer value }. This is typically
83      *          read from attrs.xml in the SDK target.
84      * @param log a {@link LayoutLog} object. Can be null.
85      * @return true if success.
86      */
87     public boolean init(Map<String, String> platformProperties,
88             File fontLocation,
89             String nativeLibraryPath,
90             String dataPath,
91             Map<String, Map<String, Integer>> enumValueMap,
92             LayoutLog log) {
93         return false;
94     }
95
96     public boolean init(Map<String, String> platformProperties,
97             File fontLocation,
98             Map<String, Map<String, Integer>> enumValueMap,
99             LayoutLog log) {
100         return init(platformProperties, fontLocation, null, null, enumValueMap, log);
101     }
102
103     /**
104      * Prepares the layoutlib to unloaded.
105      */
106     public boolean dispose() {
107         return false;
108     }
109
110     /**
111      * Starts a layout session by inflating and rendering it. The method returns a
112      * {@link RenderSession} on which further actions can be taken.
113      *
114      * @return a new {@link RenderSession} object that contains the result of the scene creation and
115      * first rendering.
116      */
117     public RenderSession createSession(SessionParams params) {
118         return null;
119     }
120
121     /**
122      * Renders a Drawable. If the rendering is successful, the result image is accessible through
123      * {@link Result#getData()}. It is of type {@link BufferedImage}
124      * @param params the rendering parameters.
125      * @return the result of the action.
126      */
127     public Result renderDrawable(DrawableParams params) {
128         return Status.NOT_IMPLEMENTED.createResult();
129     }
130
131     /**
132      * Clears the resource cache for a specific project.
133      * <p>This cache contains bitmaps and nine patches that are loaded from the disk and reused
134      * until this method is called.
135      * <p>The cache is not configuration dependent and should only be cleared when a
136      * resource changes (at this time only bitmaps and 9 patches go into the cache).
137      * <p>
138      * The project key provided must be similar to the one passed in {@link RenderParams}.
139      *
140      * @param projectKey the key for the project.
141      */
142     public void clearCaches(Object projectKey) {
143
144     }
145
146     /**
147      * Utility method returning the parent of a given view object.
148      *
149      * @param viewObject the object for which to return the parent.
150      *
151      * @return a {@link Result} indicating the status of the action, and if success, the parent
152      *      object in {@link Result#getData()}
153      */
154     public Result getViewParent(Object viewObject) {
155         return NOT_IMPLEMENTED.createResult();
156     }
157
158     /**
159      * Utility method returning the index of a given view in its parent.
160      * @param viewObject the object for which to return the index.
161      *
162      * @return a {@link Result} indicating the status of the action, and if success, the index in
163      *      the parent in {@link Result#getData()}
164      */
165     public Result getViewIndex(Object viewObject) {
166         return NOT_IMPLEMENTED.createResult();
167     }
168
169     /**
170      * Returns true if the character orientation of the locale is right to left.
171      * @param locale The locale formatted as language-region
172      * @return true if the locale is right to left.
173      */
174     public boolean isRtl(String locale) {
175         return false;
176     }
177
178     /**
179      * Utility method returning the baseline value for a given view object. This basically returns
180      * View.getBaseline().
181      *
182      * @param viewObject the object for which to return the index.
183      *
184      * @return the baseline value or -1 if not applicable to the view object or if this layout
185      *     library does not implement this method.
186      *
187      * @deprecated use the extended ViewInfo.
188      */
189     @Deprecated
190     public Result getViewBaseline(Object viewObject) {
191         return NOT_IMPLEMENTED.createResult();
192     }
193 }