xref: /frameworks/base/tools/layoutlib/bridge/src/android/graphics/Xfermode_Delegate.java

/*
 * 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 android.graphics;

import com.android.layoutlib.bridge.impl.DelegateManager;
import com.android.tools.layoutlib.annotations.LayoutlibDelegate;

import java.awt.Composite;

/**
 * Delegate implementing the native methods of android.graphics.Xfermode
 *
 * Through the layoutlib_create tool, the original native methods of Xfermode have been replaced
 * by calls to methods of the same name in this delegate class.
 *
 * This class behaves like the original native implementation, but in Java, keeping previously
 * native data into its own objects and mapping them to int that are sent back and forth between
 * it and the original Xfermode class.
 *
 * This also serve as a base class for all Xfermode delegate classes.
 *
 * @see DelegateManager
 *
 */
public abstract class Xfermode_Delegate {

    // ---- delegate manager ----
    protected static final DelegateManager<Xfermode_Delegate> sManager =
            new DelegateManager<Xfermode_Delegate>(Xfermode_Delegate.class);

    // ---- delegate helper data ----

    // ---- delegate data ----

    // ---- Public Helper methods ----

    public static Xfermode_Delegate getDelegate(int native_instance) {
        return sManager.getDelegate(native_instance);
    }

    public abstract Composite getComposite(int alpha);
    public abstract boolean isSupported();
    public abstract String getSupportMessage();


    // ---- native methods ----

    @LayoutlibDelegate
    /*package*/ static void finalizer(int native_instance) {
        sManager.removeJavaReferenceFor(native_instance);
    }

    // ---- Private delegate/helper methods ----

}