Home | History | Annotate | Download | only in api
      1 /*
      2  * Copyright (C) 2008 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 import org.xmlpull.v1.XmlPullParser;
     20 
     21 /**
     22  * Extended version of {@link XmlPullParser} to use with
     23  * {@link Bridge#createScene(SceneParams)}
     24  */
     25 public interface ILayoutPullParser extends XmlPullParser {
     26 
     27     /**
     28      * Returns a cookie for the current XML node.
     29      * <p/>This cookie will be passed back in the {@link ViewInfo} objects, allowing association
     30      * of a particular XML node with its result from the layout computation.
     31      *
     32      * @see ViewInfo#getCookie()
     33      */
     34     Object getViewCookie();
     35 
     36     /**
     37      * Returns a custom parser for the layout of the given name.
     38      * @param layoutName the name of the layout.
     39      * @return returns a custom parser or null if no custom parsers are needed.
     40      *
     41      * @deprecated use {@link IProjectCallback#getParser(String)} instead
     42      */
     43     @Deprecated
     44     ILayoutPullParser getParser(String layoutName);
     45 }
     46 
     47