KeyboardThemeFactory.java

/*
 * Copyright (c) 2013 Menny Even-Danan
 *
 * 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.anysoftkeyboard.theme;

import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;
import android.util.AttributeSet;
import com.anysoftkeyboard.addons.AddOnsFactory;
import com.anysoftkeyboard.utils.Log;
import com.menny.android.anysoftkeyboard.R;

import java.util.ArrayList;

public class KeyboardThemeFactory extends AddOnsFactory<KeyboardTheme> {

    private static final KeyboardThemeFactory msInstance;

    static {
        msInstance = new KeyboardThemeFactory();
    }

    public static KeyboardTheme getCurrentKeyboardTheme(Context appContext) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext);
        String settingKey = appContext.getString(R.string.settings_key_keyboard_theme_key);

        String selectedThemeId = sharedPreferences.getString(settingKey, appContext.getString(R.string.settings_default_keyboard_theme_key));
        KeyboardTheme selectedTheme = null;
        ArrayList<KeyboardTheme> themes = msInstance.getAllAddOns(appContext);
        if (selectedThemeId != null) {
            //Find the builder in the array by id. Mayne would've been better off with a HashSet
            for (KeyboardTheme aTheme : themes) {
                if (aTheme.getId().equals(selectedThemeId)) {
                    selectedTheme = aTheme;
                    break;
                }
            }
        }

        if (selectedTheme == null) {
            //Haven't found a builder or no preference is stored, so we use the default one
            selectedTheme = themes.get(0);

            SharedPreferences.Editor editor = sharedPreferences.edit();
            editor.putString(settingKey, selectedTheme.getId());
            editor.commit();
        }

        return selectedTheme;
    }


    public static ArrayList<KeyboardTheme> getAllAvailableThemes(Context applicationContext) {
        return msInstance.getAllAddOns(applicationContext);
    }

    private static final String XML_POPUP_KEYBOARD_THEME_RES_ID_ATTRIBUTE = "themeRes";
    private static final String XML_POPUP_KEYBOARD_POPUP_THEME_RES_ID_ATTRIBUTE = "popupThemeRes";
    private static final String XML_POPUP_KEYBOARD_ICONS_THEME_RES_ID_ATTRIBUTE = "iconsThemeRes";
    private static final String XML_POPUP_KEYBOARD_THEME_SCREENSHOT_RES_ID_ATTRIBUTE = "themeScreenshot";

    private KeyboardThemeFactory() {
        super("ASK_KT", "com.anysoftkeyboard.plugin.KEYBOARD_THEME", "com.anysoftkeyboard.plugindata.keyboardtheme",
                "KeyboardThemes", "KeyboardTheme",
                R.xml.keyboard_themes, true);
    }

    @Override
    protected KeyboardTheme createConcreteAddOn(Context askContext, Context context, String prefId, int nameResId, String description, int sortIndex, AttributeSet attrs) {
        final int keyboardThemeResId = attrs.getAttributeResourceValue(null,
                XML_POPUP_KEYBOARD_THEME_RES_ID_ATTRIBUTE, 0);
        final int popupKeyboardThemeResId = attrs.getAttributeResourceValue(null,
                XML_POPUP_KEYBOARD_POPUP_THEME_RES_ID_ATTRIBUTE, 0);
        final int keyboardThemeScreenshotResId = attrs.getAttributeResourceValue(null,
                XML_POPUP_KEYBOARD_THEME_SCREENSHOT_RES_ID_ATTRIBUTE, 0);
        final int iconsThemeResId = attrs.getAttributeResourceValue(null,
                XML_POPUP_KEYBOARD_ICONS_THEME_RES_ID_ATTRIBUTE, 0);

        if (keyboardThemeResId == -1) {
            String detailMessage = String.format("Missing details for creating Keyboard theme! prefId %s, " +
                    "keyboardThemeResId: %d, keyboardThemeScreenshotResId: %d",
                    prefId, keyboardThemeResId, keyboardThemeScreenshotResId);

            throw new RuntimeException(detailMessage);
        }
        return new KeyboardTheme(askContext, context, prefId, nameResId,
                keyboardThemeResId, popupKeyboardThemeResId, iconsThemeResId,
                keyboardThemeScreenshotResId, description, sortIndex);
    }


    public static KeyboardTheme getFallbackTheme(Context appContext) {
        final String defaultThemeId = appContext.getString(R.string.settings_default_keyboard_theme_key);
        ArrayList<KeyboardTheme> themes = msInstance.getAllAddOns(appContext);
        if (defaultThemeId != null) {
            //Find the builder in the array by id. Maybe would've been better off with a HashSet
            for (KeyboardTheme aTheme : themes) {
                if (aTheme.getId().equals(defaultThemeId)) {
                    return aTheme;
                }
            }
        }

        return getCurrentKeyboardTheme(appContext.getApplicationContext());
    }

    @Override
    protected boolean isEventRequiresViewReset(Intent eventIntent, Context context) {
        //will reset ONLY if this is the active theme
        KeyboardTheme selectedTheme = getCurrentKeyboardTheme(context.getApplicationContext());
        if ((selectedTheme != null) && (selectedTheme.getPackageName().equals(eventIntent.getData().getSchemeSpecificPart()))) {
            Log.d(TAG, "It seems that selected keyboard theme has been changed. I need to reload view!");
            return true;
        }
        return false;
    }
}