Wizard refactor: beginning

This commit is contained in:
serso
2015-01-28 22:46:39 +01:00
parent 070d0a12d1
commit 099d330f9d
28 changed files with 1217 additions and 319 deletions

View File

@@ -1,50 +0,0 @@
/*
* Copyright 2013 serso aka se.solovyev
*
* 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.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Contact details
*
* Email: se.solovyev@gmail.com
* Site: http://se.solovyev.org
*/
package org.solovyev.android.calculator.wizard;
import org.solovyev.android.calculator.CalculatorApplication;
import org.solovyev.android.calculator.R;
import org.solovyev.android.wizard.BaseWizardActivity;
import org.solovyev.android.wizard.Wizards;
import javax.annotation.Nonnull;
public final class CalculatorWizardActivity extends BaseWizardActivity {
@Nonnull
private Wizards wizards;
public CalculatorWizardActivity() {
super(R.layout.cpp_wizard);
this.wizards = CalculatorApplication.getInstance().getWizards();
}
@Nonnull
public Wizards getWizards() {
return wizards;
}
public void setWizards(@Nonnull Wizards wizards) {
this.wizards = wizards;
}
}

View File

@@ -27,7 +27,7 @@ public class CalculatorWizards implements Wizards {
@Nonnull
@Override
public Class<? extends Activity> getActivityClassName() {
return CalculatorWizardActivity.class;
return WizardActivity.class;
}
@Nonnull

View File

@@ -23,22 +23,23 @@
package org.solovyev.android.calculator.wizard;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import org.solovyev.android.calculator.R;
/**
* User: serso
* Date: 6/16/13
* Time: 9:44 PM
*/
public final class WelcomeWizardStep extends Fragment {
public final class WelcomeWizardStep extends WizardFragment {
@Override
protected int getViewResId() {
return R.layout.cpp_wizard_step_welcome;
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
return inflater.inflate(R.layout.cpp_wizard_step_welcome, null);
final View view = super.onCreateView(inflater, container, savedInstanceState);
setupNextButton(R.string.wizard_start);
setupPrevButton(R.string.wizard_skip);
return view;
}
}

View File

@@ -0,0 +1,139 @@
package org.solovyev.android.calculator.wizard;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentStatePagerAdapter;
import android.support.v4.view.PagerAdapter;
import android.support.v4.view.ViewPager;
import com.viewpagerindicator.PageIndicator;
import org.solovyev.android.calculator.BaseActivity;
import org.solovyev.android.calculator.CalculatorApplication;
import org.solovyev.android.calculator.R;
import org.solovyev.android.wizard.*;
import javax.annotation.Nonnull;
public class WizardActivity extends BaseActivity implements WizardsAware {
@Nonnull
private final WizardUi<WizardActivity> wizardUi = new WizardUi<WizardActivity>(this, this, 0);
@Nonnull
private ViewPager pager;
@Nonnull
private PagerAdapter pagerAdapter;
public WizardActivity() {
super(R.layout.cpp_activity_wizard);
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
wizardUi.onCreate(savedInstanceState);
getSupportActionBar().hide();
final ListWizardFlow flow = (ListWizardFlow) wizardUi.getFlow();
pager = (ViewPager) findViewById(R.id.pager);
pagerAdapter = new WizardPagerAdapter(flow, getSupportFragmentManager());
pager.setAdapter(pagerAdapter);
final PageIndicator titleIndicator = (PageIndicator) findViewById(R.id.pager_indicator);
titleIndicator.setViewPager(pager);
titleIndicator.setOnPageChangeListener(new ViewPager.SimpleOnPageChangeListener() {
@Override
public void onPageSelected(int position) {
wizardUi.setStep(flow.getStepAt(position));
}
});
if (savedInstanceState == null) {
final int position = flow.getPositionFor(wizardUi.getStep());
pager.setCurrentItem(position);
}
}
@Override
public void onBackPressed() {
if (pager.getCurrentItem() == 0) {
super.onBackPressed();
} else {
pager.setCurrentItem(pager.getCurrentItem() - 1);
}
}
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
wizardUi.onSaveInstanceState(outState);
}
@Override
protected void onPause() {
super.onPause();
wizardUi.onPause();
}
@Nonnull
@Override
public Wizards getWizards() {
return CalculatorApplication.getInstance().getWizards();
}
public void finishWizardAbruptly() {
wizardUi.finishWizardAbruptly();
finish();
}
public void finishWizard() {
wizardUi.finishWizard();
finish();
}
public boolean canGoNext() {
final int position = pager.getCurrentItem();
return position != pagerAdapter.getCount() - 1;
}
public boolean canGoPrev() {
final int position = pager.getCurrentItem();
return position != 0;
}
public void goNext() {
final int position = pager.getCurrentItem();
if (position < pagerAdapter.getCount() - 1) {
pager.setCurrentItem(position + 1, true);
}
}
public void goPrev() {
final int position = pager.getCurrentItem();
if (position > 0) {
pager.setCurrentItem(position - 1, true);
}
}
private class WizardPagerAdapter extends FragmentStatePagerAdapter {
@Nonnull
private final ListWizardFlow flow;
public WizardPagerAdapter(@Nonnull ListWizardFlow flow, @Nonnull FragmentManager fm) {
super(fm);
this.flow = flow;
}
@Override
public Fragment getItem(int position) {
final WizardStep step = flow.getStepAt(position);
final String className = step.getFragmentClass().getName();
final Bundle args = step.getFragmentArgs();
return Fragment.instantiate(WizardActivity.this, className, args);
}
@Override
public int getCount() {
return flow.getCount();
}
}
}

View File

@@ -0,0 +1,72 @@
package org.solovyev.android.calculator.wizard;
import android.os.Bundle;
import android.support.annotation.LayoutRes;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;
import org.solovyev.android.calculator.R;
import javax.annotation.Nullable;
public abstract class WizardFragment extends Fragment implements View.OnClickListener {
@Nullable
private TextView nextButton;
@Nullable
private TextView prevButton;
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
final View view = inflater.inflate(R.layout.fragment_wizard, container, false);
final ViewGroup content = (ViewGroup) view.findViewById(R.id.wizard_content);
inflater.inflate(getViewResId(), content, true);
nextButton = (TextView) view.findViewById(R.id.wizard_next);
if (nextButton != null) {
nextButton.setOnClickListener(this);
}
prevButton = (TextView) view.findViewById(R.id.wizard_prev);
if (prevButton != null) {
prevButton.setOnClickListener(this);
}
return view;
}
protected final void setupNextButton(int textResId) {
assert nextButton != null;
nextButton.setText(textResId);
}
protected final void setupPrevButton(int textResId) {
assert prevButton != null;
prevButton.setText(textResId);
}
@LayoutRes
protected abstract int getViewResId();
@Override
public void onClick(View v) {
final int id = v.getId();
final WizardActivity activity = (WizardActivity) getActivity();
if (id == R.id.wizard_next) {
if (activity.canGoNext()) {
activity.goNext();
} else {
activity.finishWizard();
}
} else if (id == R.id.wizard_prev) {
if (activity.canGoPrev()) {
activity.goPrev();
} else {
activity.finishWizardAbruptly();
}
}
}
}

View File

@@ -1,44 +0,0 @@
package org.solovyev.android.wizard;
import android.os.Bundle;
import android.support.v7.app.ActionBarActivity;
import javax.annotation.Nonnull;
public abstract class BaseWizardActivity extends ActionBarActivity implements WizardsAware, FinishWizardConfirmationDialog.Listener {
@Nonnull
private WizardUi ui;
protected BaseWizardActivity(int layoutResId) {
ui = new WizardUi<BaseWizardActivity>(this, this, layoutResId);
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ui.onCreate(savedInstanceState);
}
@Override
protected void onSaveInstanceState(Bundle out) {
super.onSaveInstanceState(out);
ui.onSaveInstanceState(out);
}
@Override
public void onPause() {
super.onPause();
ui.onPause();
}
@Override
public void onBackPressed() {
ui.onBackPressed();
}
@Override
public void finishWizardAbruptly() {
ui.finishWizardAbruptly();
}
}

View File

@@ -22,33 +22,28 @@
package org.solovyev.android.wizard;
import org.solovyev.common.JPredicate;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
import static org.solovyev.common.collections.Collections.find;
public final class ListWizardFlow implements WizardFlow {
@Nonnull
private final List<WizardStep> steps;
private final List<? extends WizardStep> steps;
public ListWizardFlow(@Nonnull List<WizardStep> steps) {
public ListWizardFlow(@Nonnull List<? extends WizardStep> steps) {
this.steps = steps;
}
@Nullable
@Override
public WizardStep getStepByName(@Nonnull final String name) {
return find(steps, new JPredicate<WizardStep>() {
@Override
public boolean apply(@Nullable WizardStep step) {
assert step != null;
return step.getName().equals(name);
for (WizardStep step : steps) {
if (step.getName().equals(name)) {
return step;
}
});
}
return null;
}
@Nullable
@@ -78,4 +73,24 @@ public final class ListWizardFlow implements WizardFlow {
public WizardStep getFirstStep() {
return steps.get(0);
}
@Nonnull
public WizardStep getStepAt(int position) {
return steps.get(position);
}
public int getPositionFor(@Nonnull WizardStep step) {
for (int i = 0; i < steps.size(); i++) {
if (steps.get(i).equals(step)) {
return i;
}
}
return -1;
}
public int getCount() {
return steps.size();
}
}

View File

@@ -6,63 +6,25 @@ import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentActivity;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentTransaction;
import android.view.View;
import android.widget.Button;
import org.solovyev.android.calculator.R;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import static android.view.View.GONE;
import static android.view.View.VISIBLE;
public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialog.Listener> {
/*
**********************************************************************
*
* CONSTANTS
*
**********************************************************************
*/
public class WizardUi<A extends FragmentActivity> {
private static final String FLOW = "flow";
private static final String STEP = "step";
/*
**********************************************************************
*
* FIELDS
*
**********************************************************************
*/
private WizardStep step;
private Wizard wizard;
/*
**********************************************************************
*
* VIEWS
*
**********************************************************************
*/
@Nullable
private View prevButton;
protected WizardStep step;
protected Wizard wizard;
@Nonnull
private Button nextButton;
protected final A activity;
@Nonnull
private final A activity;
protected final WizardsAware wizardsAware;
@Nonnull
private final WizardsAware wizardsAware;
private final int layoutResId;
protected final int layoutResId;
public WizardUi(@Nonnull A activity, @Nonnull WizardsAware wizardsAware, int layoutResId) {
this.activity = activity;
@@ -70,22 +32,14 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
this.layoutResId = layoutResId;
}
/*
**********************************************************************
*
* LIFECYCLE
*
**********************************************************************
*/
public void onCreate(@Nullable Bundle savedInstanceState) {
activity.setContentView(layoutResId);
if (layoutResId != 0) {
activity.setContentView(layoutResId);
}
prevButton = activity.findViewById(R.id.acl_wizard_prev_button);
nextButton = (Button) activity.findViewById(R.id.acl_wizard_next_button);
String wizardName = activity.getIntent().getStringExtra(FLOW);
String stepName = activity.getIntent().getStringExtra(STEP);
final Intent intent = activity.getIntent();
String wizardName = intent.getStringExtra(FLOW);
String stepName = intent.getStringExtra(STEP);
if (savedInstanceState != null) {
wizardName = savedInstanceState.getString(FLOW);
stepName = savedInstanceState.getString(STEP);
@@ -93,7 +47,6 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
wizard = wizardsAware.getWizards().getWizard(wizardName);
WizardStep step = null;
if (stepName != null) {
step = wizard.getFlow().getStepByName(stepName);
}
@@ -101,70 +54,10 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
if (step == null) {
step = wizard.getFlow().getFirstStep();
}
setStep(step);
}
public void setStep(@Nonnull WizardStep step) {
if (this.step == null || !this.step.equals(step)) {
hideFragment();
this.step = step;
showFragment();
initTitle();
initNextButton();
initPrevButton();
}
}
private void initTitle() {
activity.setTitle(step.getTitleResId());
}
private void initPrevButton() {
if (prevButton != null) {
final WizardStep prevStep = wizard.getFlow().getPrevStep(step);
if (prevStep == null) {
prevButton.setVisibility(GONE);
prevButton.setOnClickListener(null);
} else {
prevButton.setVisibility(VISIBLE);
prevButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
if (tryGoPrev()) {
setStep(prevStep);
}
}
});
}
}
}
private void initNextButton() {
final WizardStep nextStep = wizard.getFlow().getNextStep(step);
if (nextStep == null) {
nextButton.setText(R.string.acl_wizard_finish);
nextButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
if (tryGoNext()) {
finishWizard();
}
}
});
} else {
nextButton.setText(step.getNextButtonTitleResId());
nextButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
if (tryGoNext()) {
setStep(nextStep);
}
}
});
}
public void setStep(WizardStep step) {
this.step = step;
}
public void finishWizardAbruptly() {
@@ -175,14 +68,14 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
finishWizard(false);
}
void finishWizard(boolean forceFinish) {
protected final void finishWizard(boolean forceFinish) {
if (wizard != null && step != null) {
wizard.saveFinished(step, forceFinish);
}
activity.finish();
}
private boolean tryGoPrev() {
protected final boolean tryGoPrev() {
if (step == null) {
return true;
} else {
@@ -192,11 +85,11 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
}
@Nonnull
private FragmentManager getFragmentManager() {
protected final FragmentManager getFragmentManager() {
return activity.getSupportFragmentManager();
}
private boolean tryGoNext() {
protected final boolean tryGoNext() {
if (step == null) {
return true;
} else {
@@ -205,43 +98,6 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
}
}
@Nonnull
private Fragment showFragment() {
final FragmentManager fm = getFragmentManager();
final FragmentTransaction ft = fm.beginTransaction();
Fragment newFragment = fm.findFragmentByTag(step.getFragmentTag());
if (newFragment == null) {
newFragment = Fragment.instantiate(activity, step.getFragmentClass().getName(), step.getFragmentArgs());
ft.add(R.id.acl_wizard_content, newFragment, step.getFragmentTag());
}
ft.commit();
fm.executePendingTransactions();
return newFragment;
}
private void hideFragment() {
final FragmentManager fm = getFragmentManager();
final FragmentTransaction ft = fm.beginTransaction();
if (step != null) {
hideFragmentByTag(fm, ft, step.getFragmentTag());
}
ft.commit();
fm.executePendingTransactions();
}
private void hideFragmentByTag(@Nonnull FragmentManager fm, @Nonnull FragmentTransaction ft, @Nonnull String fragmentTag) {
final Fragment oldFragment = fm.findFragmentByTag(fragmentTag);
if (oldFragment != null) {
ft.remove(oldFragment);
}
}
public void onSaveInstanceState(@Nonnull Bundle out) {
out.putString(FLOW, wizard.getName());
out.putString(STEP, step.getName());
@@ -253,18 +109,6 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
}
}
public void onBackPressed() {
FinishWizardConfirmationDialog.show(activity);
}
/*
**********************************************************************
*
* GETTERS
*
**********************************************************************
*/
public WizardStep getStep() {
return step;
}
@@ -277,23 +121,6 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
return wizard;
}
@Nullable
public View getPrevButton() {
return prevButton;
}
public View getNextButton() {
return nextButton;
}
/*
**********************************************************************
*
* STATIC
*
**********************************************************************
*/
public static void startWizard(@Nonnull Wizards wizards, @Nonnull Context context) {
context.startActivity(createLaunchIntent(wizards, null, context));
}
@@ -329,5 +156,4 @@ public class WizardUi<A extends FragmentActivity & FinishWizardConfirmationDialo
intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
return intent;
}
}