Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 702e2ebf authored by Jason Monk's avatar Jason Monk
Browse files

Add plugin API for individual QS tiles 

This will allow prototyping of individual QS tiles and/or their
visual representation without having to write a plugin for the
entire panel. This will allow quick iteration on QS UI + dual
target tiles.

Test: Install plugin using new API
Change-Id: I05ca9d9f5a200a1dad2c3582251a36edb5cb9aba
parent 5a4e12e1

packages/SystemUI/plugin/src/com/android/systemui/plugins/qs/QSFactory.java

0 → 100644
+36 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.systemui.plugins.qs;



import com.android.systemui.plugins.Plugin;

import com.android.systemui.plugins.annotations.DependsOn;

import com.android.systemui.plugins.annotations.ProvidesInterface;



/**

 * Plugin that has the ability to create or override any part of

 * QS tiles.

 */

@ProvidesInterface(action = QSFactory.ACTION, version = QSFactory.VERSION)

@DependsOn(target = QSTile.class)

@DependsOn(target = QSTileView.class)

public interface QSFactory extends Plugin {



    String ACTION = "com.android.systemui.action.PLUGIN_QS_FACTORY";

    int VERSION = 1;



    QSTile createTile(String tileSpec);

    QSTileView createTileView(QSTile tile, boolean collapsedView);



}

packages/SystemUI/plugin/src/com/android/systemui/plugins/qs/QSIconView.java

0 → 100644
+35 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.systemui.plugins.qs;



import android.content.Context;

import android.view.View;

import android.view.ViewGroup;



import com.android.systemui.plugins.annotations.ProvidesInterface;

import com.android.systemui.plugins.qs.QSTile.State;



@ProvidesInterface(version = QSIconView.VERSION)

public abstract class QSIconView extends ViewGroup {

    public static final int VERSION = 1;



    public QSIconView(Context context) {

        super(context);

    }



    public abstract void setIcon(State state);

    public abstract void disableAnimation();

    public abstract View getIconView();

}

packages/SystemUI/plugin/src/com/android/systemui/plugins/qs/QSTile.java

0 → 100644
+241 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.systemui.plugins.qs;



import android.content.Context;

import android.graphics.drawable.Drawable;

import android.service.quicksettings.Tile;



import com.android.systemui.plugins.annotations.DependsOn;

import com.android.systemui.plugins.annotations.ProvidesInterface;

import com.android.systemui.plugins.qs.QS.DetailAdapter;

import com.android.systemui.plugins.qs.QSTile.Callback;

import com.android.systemui.plugins.qs.QSTile.Icon;

import com.android.systemui.plugins.qs.QSTile.State;



import java.util.Objects;



@ProvidesInterface(version = QSTile.VERSION)

@DependsOn(target = QSIconView.class)

@DependsOn(target = DetailAdapter.class)

@DependsOn(target = Callback.class)

@DependsOn(target = Icon.class)

@DependsOn(target = State.class)

public interface QSTile {

    int VERSION = 1;



    DetailAdapter getDetailAdapter();

    String getTileSpec();



    boolean isAvailable();

    void setTileSpec(String tileSpec);



    void clearState();

    void refreshState();



    void addCallback(Callback callback);

    void removeCallback(Callback callback);

    void removeCallbacks();



    QSIconView createTileView(Context context);

    

    void click();

    void secondaryClick();

    void longClick();



    void userSwitch(int currentUser);

    int getMetricsCategory();



    void setListening(Object client, boolean listening);

    void setDetailListening(boolean show);



    void destroy();



    CharSequence getTileLabel();



    State getState();



    @ProvidesInterface(version = Callback.VERSION)

    public interface Callback {

        public static final int VERSION = 1;

        void onStateChanged(State state);

        void onShowDetail(boolean show);

        void onToggleStateChanged(boolean state);

        void onScanStateChanged(boolean state);

        void onAnnouncementRequested(CharSequence announcement);

    }



    @ProvidesInterface(version = Icon.VERSION)

    public static abstract class Icon {

        public static final int VERSION = 1;

        abstract public Drawable getDrawable(Context context);



        public Drawable getInvisibleDrawable(Context context) {

            return getDrawable(context);

        }



        @Override

        public int hashCode() {

            return Icon.class.hashCode();

        }



        public int getPadding() {

            return 0;

        }

    }



    @ProvidesInterface(version = State.VERSION)

    public static class State {

        public static final int VERSION = 1;

        public Icon icon;

        public int state = Tile.STATE_ACTIVE;

        public CharSequence label;

        public CharSequence contentDescription;

        public CharSequence dualLabelContentDescription;

        public boolean disabledByPolicy;

        public boolean dualTarget = false;

        public String expandedAccessibilityClassName;



        public boolean copyTo(State other) {

            if (other == null) throw new IllegalArgumentException();

            if (!other.getClass().equals(getClass())) throw new IllegalArgumentException();

            final boolean changed = !Objects.equals(other.icon, icon)

                    || !Objects.equals(other.label, label)

                    || !Objects.equals(other.contentDescription, contentDescription)

                    || !Objects.equals(other.dualLabelContentDescription,

                            dualLabelContentDescription)

                    || !Objects.equals(other.expandedAccessibilityClassName,

                            expandedAccessibilityClassName)

                    || !Objects.equals(other.disabledByPolicy, disabledByPolicy)

                    || !Objects.equals(other.state, state)

                    || !Objects.equals(other.dualTarget, dualTarget);

            other.icon = icon;

            other.label = label;

            other.contentDescription = contentDescription;

            other.dualLabelContentDescription = dualLabelContentDescription;

            other.expandedAccessibilityClassName = expandedAccessibilityClassName;

            other.disabledByPolicy = disabledByPolicy;

            other.state = state;

            other.dualTarget = dualTarget;

            return changed;

        }



        @Override

        public String toString() {

            return toStringBuilder().toString();

        }



        protected StringBuilder toStringBuilder() {

            final StringBuilder sb = new StringBuilder(getClass().getSimpleName()).append('[');

            sb.append(",icon=").append(icon);

            sb.append(",label=").append(label);

            sb.append(",contentDescription=").append(contentDescription);

            sb.append(",dualLabelContentDescription=").append(dualLabelContentDescription);

            sb.append(",expandedAccessibilityClassName=").append(expandedAccessibilityClassName);

            sb.append(",disabledByPolicy=").append(disabledByPolicy);

            sb.append(",dualTarget=").append(dualTarget);

            sb.append(",state=").append(state);

            return sb.append(']');

        }



        public State copy() {

            State state = new State();

            copyTo(state);

            return state;

        }

    }



    @ProvidesInterface(version = BooleanState.VERSION)

    public static class BooleanState extends State {

        public static final int VERSION = 1;

        public boolean value;



        @Override

        public boolean copyTo(State other) {

            final BooleanState o = (BooleanState) other;

            final boolean changed = super.copyTo(other) || o.value != value;

            o.value = value;

            return changed;

        }



        @Override

        protected StringBuilder toStringBuilder() {

            final StringBuilder rt = super.toStringBuilder();

            rt.insert(rt.length() - 1, ",value=" + value);

            return rt;

        }



        @Override

        public State copy() {

            BooleanState state = new BooleanState();

            copyTo(state);

            return state;

        }

    }



    @ProvidesInterface(version = SignalState.VERSION)

    public static final class SignalState extends BooleanState {

        public static final int VERSION = 1;

        public boolean activityIn;

        public boolean activityOut;



        @Override

        public boolean copyTo(State other) {

            final SignalState o = (SignalState) other;

            final boolean changed = o.activityIn != activityIn

                    || o.activityOut != activityOut;

            o.activityIn = activityIn;

            o.activityOut = activityOut;

            return super.copyTo(other) || changed;

        }



        @Override

        protected StringBuilder toStringBuilder() {

            final StringBuilder rt = super.toStringBuilder();

            rt.insert(rt.length() - 1, ",activityIn=" + activityIn);

            rt.insert(rt.length() - 1, ",activityOut=" + activityOut);

            return rt;

        }



        @Override

        public State copy() {

            SignalState state = new SignalState();

            copyTo(state);

            return state;

        }

    }





    @ProvidesInterface(version = AirplaneBooleanState.VERSION)

    public static class AirplaneBooleanState extends BooleanState {

        public static final int VERSION = 1;

        public boolean isAirplaneMode;



        @Override

        public boolean copyTo(State other) {

            final AirplaneBooleanState o = (AirplaneBooleanState) other;

            final boolean changed = super.copyTo(other) || o.isAirplaneMode != isAirplaneMode;

            o.isAirplaneMode = isAirplaneMode;

            return changed;

        }



        public State copy() {

            AirplaneBooleanState state = new AirplaneBooleanState();

            copyTo(state);

            return state;

        }

    }



}

packages/SystemUI/plugin/src/com/android/systemui/plugins/qs/QSTileView.java

0 → 100644
+41 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.systemui.plugins.qs;



import android.content.Context;

import android.view.View;

import android.widget.LinearLayout;



import com.android.systemui.plugins.annotations.DependsOn;

import com.android.systemui.plugins.annotations.ProvidesInterface;

import com.android.systemui.plugins.qs.QSTile.State;



@ProvidesInterface(version = QSTileView.VERSION)

@DependsOn(target = QSIconView.class)

@DependsOn(target = QSTile.class)

public abstract class QSTileView extends LinearLayout {

    public static final int VERSION = 1;



    public QSTileView(Context context) {

        super(context);

    }



    public abstract View updateAccessibilityOrder(View previousView);

    public abstract QSIconView getIcon();

    public abstract void init(QSTile tile);

    public abstract void onStateChanged(State state);



    public abstract int getDetailY();

}

packages/SystemUI/src/com/android/systemui/plugins/VersionInfo.java

+1 −0
Original line number Diff line number Diff line
@@ -45,6 +45,7 @@ public class VersionInfo { 
    }



    private void addClass(Class<?> cls, boolean required) {

        if (mVersions.containsKey(cls)) return;

        ProvidesInterface provider = cls.getDeclaredAnnotation(ProvidesInterface.class);

        if (provider != null) {

            mVersions.put(cls, new Version(provider.version(), true));