src/com/android/email/activity/setup/AccountServerBaseFragment.java - platform/packages/apps/Email - Git at Google

 /*
  * 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 com.android.email.activity.setup;

 import android.app.Activity;
 import android.app.Fragment;
 import android.content.Context;
 import android.os.AsyncTask;
 import android.os.Bundle;
 import android.view.KeyEvent;
 import android.view.View;
 import android.view.View.OnClickListener;
 import android.view.View.OnFocusChangeListener;
 import android.view.inputmethod.EditorInfo;
 import android.view.inputmethod.InputMethodManager;
 import android.widget.Button;
 import android.widget.TextView;
 import android.widget.TextView.OnEditorActionListener;

 import com.android.email.R;
 import com.android.email.activity.UiUtilities;
 import com.android.emailcommon.provider.Account;
 import com.android.emailcommon.provider.HostAuth;

 /**
  * Common base class for server settings fragments, so they can be more easily manipulated by
  * AccountSettingsXL.  Provides the following common functionality:
  *
  * Activity-provided callbacks
  * Activity callback during onAttach
  * Present "Next" button and respond to its clicks
  */
 public abstract class AccountServerBaseFragment extends Fragment
         implements AccountCheckSettingsFragment.Callbacks, OnClickListener {

     private static final String BUNDLE_KEY_SETTINGS = "AccountServerBaseFragment.settings";
     private static final String BUNDLE_KEY_ACTIVITY_TITLE = "AccountServerBaseFragment.title";

     protected Activity mContext;
     protected Callback mCallback = EmptyCallback.INSTANCE;
     /**
      * Whether or not we are in "settings mode". We re-use the same screens for both the initial
      * account creation as well as subsequent account modification. If <code>mSettingsMode</code>
      * if <code>false</code>, we are in account creation mode. Otherwise, we are in account
      * modification mode.
      */
     protected boolean mSettingsMode;
     /*package*/ HostAuth mLoadedSendAuth;
     /*package*/ HostAuth mLoadedRecvAuth;

     protected SetupData mSetupData;

     // This is null in the setup wizard screens, and non-null in AccountSettings mode
     private Button mProceedButton;
     // This is used to debounce multiple clicks on the proceed button (which does async work)
     private boolean mProceedButtonPressed;
     /*package*/ String mBaseScheme = "protocol";

     /**
      * Callback interface that owning activities must provide
      */
     public interface Callback {
         /**
          * Called each time the user-entered input transitions between valid and invalid
          * @param enable true to enable proceed/next button, false to disable
          */
         public void onEnableProceedButtons(boolean enable);

         /**
          * Called when user clicks "next".  Starts account checker.
          * @param checkMode values from {@link SetupData}
          * @param target the fragment that requested the check
          */
         public void onProceedNext(int checkMode, AccountServerBaseFragment target);

         /**
          * Called when account checker completes.  Fragments are responsible for saving
          * own edited data;  This is primarily for the activity to do post-check navigation.
          * @param result check settings result code - success is CHECK_SETTINGS_OK
          * @param setupData possibly modified SetupData
          */
         public void onCheckSettingsComplete(int result, SetupData setupData);
     }

     private static class EmptyCallback implements Callback {
         public static final Callback INSTANCE = new EmptyCallback();
         @Override public void onEnableProceedButtons(boolean enable) { }
         @Override public void onProceedNext(int checkMode, AccountServerBaseFragment target) { }
         @Override public void onCheckSettingsComplete(int result, SetupData setupData) { }
     }

     /**
      * Creates and returns a bundle of arguments in the format we expect
      *
      * @param settingsMode True if we're in settings, false if we're in account creation
      * @return Arg bundle
      */
     public static Bundle getArgs(Boolean settingsMode) {
         final Bundle setupModeArgs = new Bundle(1);
         setupModeArgs.putBoolean(BUNDLE_KEY_SETTINGS, settingsMode);
         return setupModeArgs;
     }

     public AccountServerBaseFragment() {}

     /**
      * At onCreate time, read the fragment arguments
      */
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);

         // Get arguments, which modally switch us into "settings" mode (different appearance)
         mSettingsMode = false;
         if (savedInstanceState != null) {
             mSettingsMode = savedInstanceState.getBoolean(BUNDLE_KEY_SETTINGS);
         } else if (getArguments() != null) {
             mSettingsMode = getArguments().getBoolean(BUNDLE_KEY_SETTINGS);
         }
         setHasOptionsMenu(true);
     }

     /**
      * Called from onCreateView, to do settings mode configuration
      */
     protected void onCreateViewSettingsMode(View view) {
         if (mSettingsMode) {
             UiUtilities.getView(view, R.id.cancel).setOnClickListener(this);
             mProceedButton = UiUtilities.getView(view, R.id.done);
             mProceedButton.setOnClickListener(this);
             mProceedButton.setEnabled(false);
         }
     }

     @Override
     public void onActivityCreated(Bundle savedInstanceState) {
         // startPreferencePanel launches this fragment with the right title initially, but
         // if the device is rotate we must set the title ourselves
         mContext = getActivity();
         if (mSettingsMode && savedInstanceState != null) {
             mContext.setTitle(savedInstanceState.getString(BUNDLE_KEY_ACTIVITY_TITLE));
         }
         SetupData.SetupDataContainer container = (SetupData.SetupDataContainer) mContext;
         mSetupData = container.getSetupData();

         super.onActivityCreated(savedInstanceState);
     }

     @Override
     public void onSaveInstanceState(Bundle outState) {
         outState.putString(BUNDLE_KEY_ACTIVITY_TITLE, (String) getActivity().getTitle());
         outState.putBoolean(BUNDLE_KEY_SETTINGS, mSettingsMode);
     }

     @Override
     public void onDetach() {
         super.onDetach();

         // Ensure that we don't have any callbacks at this point.
         mCallback = EmptyCallback.INSTANCE;
     }

     @Override
     public void onPause() {
         // Hide the soft keyboard if we lose focus
         final InputMethodManager imm =
                 (InputMethodManager)mContext.getSystemService(Context.INPUT_METHOD_SERVICE);
         imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
         super.onPause();
     }

     /**
      * Implements OnClickListener
      */
     @Override
     public void onClick(View v) {
         switch (v.getId()) {
             case R.id.cancel:
                 getActivity().onBackPressed();
                 break;
             case R.id.done:
                 // Simple debounce - just ignore while checks are underway
                 if (mProceedButtonPressed) {
                     return;
                 }
                 mProceedButtonPressed = true;
                 onNext();
                 break;
         }
     }

     /**
      * Activity provides callbacks here.
      */
     public void setCallback(Callback callback) {
         mCallback = (callback == null) ? EmptyCallback.INSTANCE : callback;
         mContext = getActivity();
     }

     /**
      * Enable/disable the "next" button
      */
     public void enableNextButton(boolean enable) {
         // If we are in settings "mode" we may be showing our own next button, and we'll
         // enable it directly, here
         if (mProceedButton != null) {
             mProceedButton.setEnabled(enable);
         }
         clearButtonBounce();

         // TODO: This supports the phone UX activities and will be removed
         mCallback.onEnableProceedButtons(enable);
     }

     /**
      * Make the given text view uneditable. If the text view is ever focused, the specified
      * error message will be displayed.
      */
     protected void makeTextViewUneditable(final TextView view, final String errorMessage) {
         // We're editing an existing account; don't allow modification of the user name
         if (mSettingsMode) {
             view.setKeyListener(null);
             view.setFocusable(true);
             view.setOnFocusChangeListener(new OnFocusChangeListener() {
                 @Override
                 public void onFocusChange(View v, boolean hasFocus) {
                     if (hasFocus) {
                         // Framework will not auto-hide IME; do it ourselves
                         InputMethodManager imm = (InputMethodManager)mContext.
                                 getSystemService(Context.INPUT_METHOD_SERVICE);
                         imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
                         view.setError(errorMessage);
                     } else {
                         view.setError(null);
                     }
                 }
             });
             view.setOnClickListener(new OnClickListener() {
                 @Override
                 public void onClick(View v) {
                     if (view.getError() == null) {
                         view.setError(errorMessage);
                     } else {
                         view.setError(null);
                     }
                 }
             });
         }
     }

     /**
      * A keyboard listener which dismisses the keyboard when "DONE" is pressed, but doesn't muck
      * around with focus. This is useful in settings screens, as we don't want focus to change
      * since some fields throw up errors when they're focused to give the user more info.
      */
     protected final OnEditorActionListener mDismissImeOnDoneListener =
             new OnEditorActionListener() {
         @Override
         public boolean onEditorAction(TextView v, int actionId, KeyEvent event) {
             if (actionId == EditorInfo.IME_ACTION_DONE) {
                 // Dismiss soft keyboard but don't modify focus.
                 final Context context = getActivity();
                 if (context == null) {
                     return false;
                 }
                 final InputMethodManager imm = (InputMethodManager) context.getSystemService(
                         Context.INPUT_METHOD_SERVICE);
                 if (imm != null && imm.isActive()) {
                     imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
                 }
                 return true;
             }
             return false;
         }
     };

     /**
      * Clears the "next" button de-bounce flags and allows the "next" button to activate.
      */
     protected void clearButtonBounce() {
         mProceedButtonPressed = false;
     }

     /**
      * Implements AccountCheckSettingsFragment.Callbacks
      *
      * Handle OK or error result from check settings.  Save settings (async), and then
      * exit to previous fragment.
      */
     @Override
     public void onCheckSettingsComplete(final int settingsResult, SetupData setupData) {
         mSetupData = setupData;
         new AsyncTask<Void, Void, Void>() {
             @Override
             protected Void doInBackground(Void... params) {
                 if (settingsResult == AccountCheckSettingsFragment.CHECK_SETTINGS_OK) {
                     if (mSetupData.getFlowMode() == SetupData.FLOW_MODE_EDIT) {
                         saveSettingsAfterEdit();
                     } else {
                         saveSettingsAfterSetup();
                     }
                 }
                 return null;
             }

             @Override
             protected void onPostExecute(Void result) {
                 // Signal to owning activity that a settings check completed
                 mCallback.onCheckSettingsComplete(settingsResult, mSetupData);
             }
         }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
     }

     /**
      * Implements AccountCheckSettingsFragment.Callbacks
      * This is overridden only by AccountSetupExchange
      */
     @Override
     public void onAutoDiscoverComplete(int result, SetupData setupData) {
         throw new IllegalStateException();
     }

     /**
      * Returns whether or not any settings have changed.
      */
     public boolean haveSettingsChanged() {
         final Account account = mSetupData.getAccount();

         final HostAuth sendAuth = account.getOrCreateHostAuthSend(mContext);
         final boolean sendChanged = (mLoadedSendAuth != null && !mLoadedSendAuth.equals(sendAuth));

         final HostAuth recvAuth = account.getOrCreateHostAuthRecv(mContext);
         final boolean recvChanged = (mLoadedRecvAuth != null && !mLoadedRecvAuth.equals(recvAuth));

         return sendChanged || recvChanged;
     }

     /**
      * Save settings after "OK" result from checker.  Concrete classes must implement.
      * This is called from a worker thread and is allowed to perform DB operations.
      */
     public abstract void saveSettingsAfterEdit();

     /**
      * Save settings after "OK" result from checker.  Concrete classes must implement.
      * This is called from a worker thread and is allowed to perform DB operations.
      */
     public abstract void saveSettingsAfterSetup();

     /**
      * Respond to a click of the "Next" button.  Concrete classes must implement.
      */
     public abstract void onNext();
 }
	/*
	* 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 com.android.email.activity.setup;

	import android.app.Activity;
	import android.app.Fragment;
	import android.content.Context;
	import android.os.AsyncTask;
	import android.os.Bundle;
	import android.view.KeyEvent;
	import android.view.View;
	import android.view.View.OnClickListener;
	import android.view.View.OnFocusChangeListener;
	import android.view.inputmethod.EditorInfo;
	import android.view.inputmethod.InputMethodManager;
	import android.widget.Button;
	import android.widget.TextView;
	import android.widget.TextView.OnEditorActionListener;

	import com.android.email.R;
	import com.android.email.activity.UiUtilities;
	import com.android.emailcommon.provider.Account;
	import com.android.emailcommon.provider.HostAuth;

	/**
	* Common base class for server settings fragments, so they can be more easily manipulated by
	* AccountSettingsXL. Provides the following common functionality:
	*
	* Activity-provided callbacks
	* Activity callback during onAttach
	* Present "Next" button and respond to its clicks
	*/
	public abstract class AccountServerBaseFragment extends Fragment
	implements AccountCheckSettingsFragment.Callbacks, OnClickListener {

	private static final String BUNDLE_KEY_SETTINGS = "AccountServerBaseFragment.settings";
	private static final String BUNDLE_KEY_ACTIVITY_TITLE = "AccountServerBaseFragment.title";

	protected Activity mContext;
	protected Callback mCallback = EmptyCallback.INSTANCE;
	/**
	* Whether or not we are in "settings mode". We re-use the same screens for both the initial
	* account creation as well as subsequent account modification. If <code>mSettingsMode</code>
	* if <code>false</code>, we are in account creation mode. Otherwise, we are in account
	* modification mode.
	*/
	protected boolean mSettingsMode;
	/package/ HostAuth mLoadedSendAuth;
	/package/ HostAuth mLoadedRecvAuth;

	protected SetupData mSetupData;

	// This is null in the setup wizard screens, and non-null in AccountSettings mode
	private Button mProceedButton;
	// This is used to debounce multiple clicks on the proceed button (which does async work)
	private boolean mProceedButtonPressed;
	/package/ String mBaseScheme = "protocol";

	/**
	* Callback interface that owning activities must provide
	*/
	public interface Callback {
	/**
	* Called each time the user-entered input transitions between valid and invalid
	* @param enable true to enable proceed/next button, false to disable
	*/
	public void onEnableProceedButtons(boolean enable);

	/**
	* Called when user clicks "next". Starts account checker.
	* @param checkMode values from {@link SetupData}
	* @param target the fragment that requested the check
	*/
	public void onProceedNext(int checkMode, AccountServerBaseFragment target);

	/**
	* Called when account checker completes. Fragments are responsible for saving
	* own edited data; This is primarily for the activity to do post-check navigation.
	* @param result check settings result code - success is CHECK_SETTINGS_OK
	* @param setupData possibly modified SetupData
	*/
	public void onCheckSettingsComplete(int result, SetupData setupData);
	}

	private static class EmptyCallback implements Callback {
	public static final Callback INSTANCE = new EmptyCallback();
	@Override public void onEnableProceedButtons(boolean enable) { }
	@Override public void onProceedNext(int checkMode, AccountServerBaseFragment target) { }
	@Override public void onCheckSettingsComplete(int result, SetupData setupData) { }
	}

	/**
	* Creates and returns a bundle of arguments in the format we expect
	*
	* @param settingsMode True if we're in settings, false if we're in account creation
	* @return Arg bundle
	*/
	public static Bundle getArgs(Boolean settingsMode) {
	final Bundle setupModeArgs = new Bundle(1);
	setupModeArgs.putBoolean(BUNDLE_KEY_SETTINGS, settingsMode);
	return setupModeArgs;
	}

	public AccountServerBaseFragment() {}

	/**
	* At onCreate time, read the fragment arguments
	*/
	@Override
	public void onCreate(Bundle savedInstanceState) {
	super.onCreate(savedInstanceState);

	// Get arguments, which modally switch us into "settings" mode (different appearance)
	mSettingsMode = false;
	if (savedInstanceState != null) {
	mSettingsMode = savedInstanceState.getBoolean(BUNDLE_KEY_SETTINGS);
	} else if (getArguments() != null) {
	mSettingsMode = getArguments().getBoolean(BUNDLE_KEY_SETTINGS);
	}
	setHasOptionsMenu(true);
	}

	/**
	* Called from onCreateView, to do settings mode configuration
	*/
	protected void onCreateViewSettingsMode(View view) {
	if (mSettingsMode) {
	UiUtilities.getView(view, R.id.cancel).setOnClickListener(this);
	mProceedButton = UiUtilities.getView(view, R.id.done);
	mProceedButton.setOnClickListener(this);
	mProceedButton.setEnabled(false);
	}
	}

	@Override
	public void onActivityCreated(Bundle savedInstanceState) {
	// startPreferencePanel launches this fragment with the right title initially, but
	// if the device is rotate we must set the title ourselves
	mContext = getActivity();
	if (mSettingsMode && savedInstanceState != null) {
	mContext.setTitle(savedInstanceState.getString(BUNDLE_KEY_ACTIVITY_TITLE));
	}
	SetupData.SetupDataContainer container = (SetupData.SetupDataContainer) mContext;
	mSetupData = container.getSetupData();

	super.onActivityCreated(savedInstanceState);
	}

	@Override
	public void onSaveInstanceState(Bundle outState) {
	outState.putString(BUNDLE_KEY_ACTIVITY_TITLE, (String) getActivity().getTitle());
	outState.putBoolean(BUNDLE_KEY_SETTINGS, mSettingsMode);
	}

	@Override
	public void onDetach() {
	super.onDetach();

	// Ensure that we don't have any callbacks at this point.
	mCallback = EmptyCallback.INSTANCE;
	}

	@Override
	public void onPause() {
	// Hide the soft keyboard if we lose focus
	final InputMethodManager imm =
	(InputMethodManager)mContext.getSystemService(Context.INPUT_METHOD_SERVICE);
	imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
	super.onPause();
	}

	/**
	* Implements OnClickListener
	*/
	@Override
	public void onClick(View v) {
	switch (v.getId()) {
	case R.id.cancel:
	getActivity().onBackPressed();
	break;
	case R.id.done:
	// Simple debounce - just ignore while checks are underway
	if (mProceedButtonPressed) {
	return;
	}
	mProceedButtonPressed = true;
	onNext();
	break;
	}
	}

	/**
	* Activity provides callbacks here.
	*/
	public void setCallback(Callback callback) {
	mCallback = (callback == null) ? EmptyCallback.INSTANCE : callback;
	mContext = getActivity();
	}

	/**
	* Enable/disable the "next" button
	*/
	public void enableNextButton(boolean enable) {
	// If we are in settings "mode" we may be showing our own next button, and we'll
	// enable it directly, here
	if (mProceedButton != null) {
	mProceedButton.setEnabled(enable);
	}
	clearButtonBounce();

	// TODO: This supports the phone UX activities and will be removed
	mCallback.onEnableProceedButtons(enable);
	}

	/**
	* Make the given text view uneditable. If the text view is ever focused, the specified
	* error message will be displayed.
	*/
	protected void makeTextViewUneditable(final TextView view, final String errorMessage) {
	// We're editing an existing account; don't allow modification of the user name
	if (mSettingsMode) {
	view.setKeyListener(null);
	view.setFocusable(true);
	view.setOnFocusChangeListener(new OnFocusChangeListener() {
	@Override
	public void onFocusChange(View v, boolean hasFocus) {
	if (hasFocus) {
	// Framework will not auto-hide IME; do it ourselves
	InputMethodManager imm = (InputMethodManager)mContext.
	getSystemService(Context.INPUT_METHOD_SERVICE);
	imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
	view.setError(errorMessage);
	} else {
	view.setError(null);
	}
	}
	});
	view.setOnClickListener(new OnClickListener() {
	@Override
	public void onClick(View v) {
	if (view.getError() == null) {
	view.setError(errorMessage);
	} else {
	view.setError(null);
	}
	}
	});
	}
	}

	/**
	* A keyboard listener which dismisses the keyboard when "DONE" is pressed, but doesn't muck
	* around with focus. This is useful in settings screens, as we don't want focus to change
	* since some fields throw up errors when they're focused to give the user more info.
	*/
	protected final OnEditorActionListener mDismissImeOnDoneListener =
	new OnEditorActionListener() {
	@Override
	public boolean onEditorAction(TextView v, int actionId, KeyEvent event) {
	if (actionId == EditorInfo.IME_ACTION_DONE) {
	// Dismiss soft keyboard but don't modify focus.
	final Context context = getActivity();
	if (context == null) {
	return false;
	}
	final InputMethodManager imm = (InputMethodManager) context.getSystemService(
	Context.INPUT_METHOD_SERVICE);
	if (imm != null && imm.isActive()) {
	imm.hideSoftInputFromWindow(getView().getWindowToken(), 0);
	}
	return true;
	}
	return false;
	}
	};

	/**
	* Clears the "next" button de-bounce flags and allows the "next" button to activate.
	*/
	protected void clearButtonBounce() {
	mProceedButtonPressed = false;
	}

	/**
	* Implements AccountCheckSettingsFragment.Callbacks
	*
	* Handle OK or error result from check settings. Save settings (async), and then
	* exit to previous fragment.
	*/
	@Override
	public void onCheckSettingsComplete(final int settingsResult, SetupData setupData) {
	mSetupData = setupData;
	new AsyncTask<Void, Void, Void>() {
	@Override
	protected Void doInBackground(Void... params) {
	if (settingsResult == AccountCheckSettingsFragment.CHECK_SETTINGS_OK) {
	if (mSetupData.getFlowMode() == SetupData.FLOW_MODE_EDIT) {
	saveSettingsAfterEdit();
	} else {
	saveSettingsAfterSetup();
	}
	}
	return null;
	}

	@Override
	protected void onPostExecute(Void result) {
	// Signal to owning activity that a settings check completed
	mCallback.onCheckSettingsComplete(settingsResult, mSetupData);
	}
	}.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
	}

	/**
	* Implements AccountCheckSettingsFragment.Callbacks
	* This is overridden only by AccountSetupExchange
	*/
	@Override
	public void onAutoDiscoverComplete(int result, SetupData setupData) {
	throw new IllegalStateException();
	}

	/**
	* Returns whether or not any settings have changed.
	*/
	public boolean haveSettingsChanged() {
	final Account account = mSetupData.getAccount();

	final HostAuth sendAuth = account.getOrCreateHostAuthSend(mContext);
	final boolean sendChanged = (mLoadedSendAuth != null && !mLoadedSendAuth.equals(sendAuth));

	final HostAuth recvAuth = account.getOrCreateHostAuthRecv(mContext);
	final boolean recvChanged = (mLoadedRecvAuth != null && !mLoadedRecvAuth.equals(recvAuth));

	return sendChanged \|\| recvChanged;
	}

	/**
	* Save settings after "OK" result from checker. Concrete classes must implement.
	* This is called from a worker thread and is allowed to perform DB operations.
	*/
	public abstract void saveSettingsAfterEdit();

	/**
	* Save settings after "OK" result from checker. Concrete classes must implement.
	* This is called from a worker thread and is allowed to perform DB operations.
	*/
	public abstract void saveSettingsAfterSetup();

	/**
	* Respond to a click of the "Next" button. Concrete classes must implement.
	*/
	public abstract void onNext();
	}