If you are overriding this method with your own custom content,
+ * consider including the standard layout {@link R.layout#fragment_progress}
+ * in your layout file, so that you continue to retain all of the standard
+ * behavior of ProgressFragment. In particular, this is currently the only
+ * way to have the built-in indeterminant progress state be shown.
+ */
+ @Override
+ public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
+ return inflater.inflate(R.layout.fragment_dialog_progress, container, false);
+ }
+
+ /**
+ * Attach to view once the view hierarchy has been created.
+ */
+ @Override
+ public void onViewCreated(View view, Bundle savedInstanceState) {
+ super.onViewCreated(view, savedInstanceState);
+ ensureContent();
+ }
+
+ /**
+ * Detach from view.
+ */
+ @Override
+ public void onDestroyView() {
+ mContentShown = false;
+ mIsContentEmpty = false;
+ mHeaderContainer = mHeaderView = null;
+ mProgressContainer = mContentContainer = mContentView = mEmptyView = null;
+ super.onDestroyView();
+ }
+
+ /**
+ * Return header view or null if the header view has not been initialized.
+ *
+ * @return header view or null
+ * @see #setHeaderView(View)
+ * @see #setHeaderView(int)
+ */
+ public View getHeaderView() {
+ return mHeaderView;
+ }
+
+ /**
+ * Set the header content from a layout resource.
+ *
+ * @param layoutResId Resource ID to be inflated.
+ * @see #setHeaderView(View)
+ * @see #getHeaderView()
+ */
+ public void setHeaderView(int layoutResId) {
+ LayoutInflater layoutInflater = LayoutInflater.from(getActivity());
+ View headerView = layoutInflater.inflate(layoutResId, null);
+ setHeaderView(headerView);
+ }
+
+ /**
+ * Set the header view to an explicit view. If the header view was installed earlier,
+ * the content will be replaced with a new view.
+ *
+ * @param view The desired header to display. Value can't be null.
+ * @see #setHeaderView(int)
+ * @see #getHeaderView()
+ */
+ public void setHeaderView(View view) {
+ ensureContent();
+ if (view == null) {
+ throw new IllegalArgumentException("Content view can't be null");
+ }
+ if (mHeaderContainer instanceof ViewGroup) {
+ ViewGroup contentContainer = (ViewGroup) mHeaderContainer;
+ if (mHeaderView == null) {
+ contentContainer.addView(view);
+ } else {
+ int index = contentContainer.indexOfChild(mHeaderView);
+ // replace content view
+ contentContainer.removeView(mHeaderView);
+ contentContainer.addView(view, index);
+ }
+ mHeaderView = view;
+ } else {
+ throw new IllegalStateException("Can't be used with a custom content view");
+ }
+ }
+
+ /**
+ * Return content view or null if the content view has not been initialized.
+ *
+ * @return content view or null
+ * @see #setContentView(View)
+ * @see #setContentView(int)
+ */
+ public View getContentView() {
+ return mContentView;
+ }
+
+ /**
+ * Set the content content from a layout resource.
+ *
+ * @param layoutResId Resource ID to be inflated.
+ * @see #setContentView(View)
+ * @see #getContentView()
+ */
+ public void setContentView(int layoutResId) {
+ LayoutInflater layoutInflater = LayoutInflater.from(getActivity());
+ View contentView = layoutInflater.inflate(layoutResId, null);
+ setContentView(contentView);
+ }
+
+ /**
+ * Set the content view to an explicit view. If the content view was installed earlier,
+ * the content will be replaced with a new view.
+ *
+ * @param view The desired content to display. Value can't be null.
+ * @see #setContentView(int)
+ * @see #getContentView()
+ */
+ public void setContentView(View view) {
+ ensureContent();
+ if (view == null) {
+ throw new IllegalArgumentException("Content view can't be null");
+ }
+ if (mContentContainer instanceof ViewGroup) {
+ ViewGroup contentContainer = (ViewGroup) mContentContainer;
+ if (mContentView == null) {
+ contentContainer.addView(view);
+ } else {
+ int index = contentContainer.indexOfChild(mContentView);
+ // replace content view
+ contentContainer.removeView(mContentView);
+ contentContainer.addView(view, index);
+ }
+ mContentView = view;
+ } else {
+ throw new IllegalStateException("Can't be used with a custom content view");
+ }
+ }
+
+ /**
+ * The default content for a ProgressFragment has a TextView that can be shown when
+ * the content is empty {@link #setContentEmpty(boolean)}.
+ * If you would like to have it shown, call this method to supply the text it should use.
+ *
+ * @param resId Identification of string from a resources
+ * @see #setEmptyText(CharSequence)
+ */
+ public void setEmptyText(int resId) {
+ setEmptyText(getString(resId));
+ }
+
+ /**
+ * The default content for a ProgressFragment has a TextView that can be shown when
+ * the content is empty {@link #setContentEmpty(boolean)}.
+ * If you would like to have it shown, call this method to supply the text it should use.
+ *
+ * @param text Text for empty view
+ * @see #setEmptyText(int)
+ */
+ public void setEmptyText(CharSequence text) {
+ ensureContent();
+ if (mEmptyView != null && mEmptyView instanceof TextView) {
+ ((TextView) mEmptyView).setText(text);
+ } else {
+ throw new IllegalStateException("Can't be used with a custom content view");
+ }
+ }
+
+ /**
+ * Control whether the content is being displayed. You can make it not
+ * displayed if you are waiting for the initial data to show in it. During
+ * this time an indeterminant progress indicator will be shown instead.
+ *
+ * @param shown If true, the content view is shown; if false, the progress
+ * indicator. The initial value is true.
+ * @see #setContentShownNoAnimation(boolean)
+ */
+ public void setContentShown(boolean shown) {
+ setContentShown(shown, true);
+ }
+
+ /**
+ * Like {@link #setContentShown(boolean)}, but no animation is used when
+ * transitioning from the previous state.
+ *
+ * @param shown If true, the content view is shown; if false, the progress
+ * indicator. The initial value is true.
+ * @see #setContentShown(boolean)
+ */
+ public void setContentShownNoAnimation(boolean shown) {
+ setContentShown(shown, false);
+ }
+
+ /**
+ * Control whether the content is being displayed. You can make it not
+ * displayed if you are waiting for the initial data to show in it. During
+ * this time an indeterminant progress indicator will be shown instead.
+ *
+ * @param shown If true, the content view is shown; if false, the progress
+ * indicator. The initial value is true.
+ * @param animate If true, an animation will be used to transition to the
+ * new state.
+ */
+ private void setContentShown(boolean shown, boolean animate) {
+ ensureContent();
+ if (mContentShown == shown) {
+ return;
+ }
+ if (mProgressContainer == null || mContentContainer == null) {
+ return;
+ }
+ mContentShown = shown;
+ if (shown) {
+ if (animate) {
+ mProgressContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_out));
+ mContentContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_in));
+ } else {
+ mProgressContainer.clearAnimation();
+ mContentContainer.clearAnimation();
+ }
+ mProgressContainer.setVisibility(View.GONE);
+ mContentContainer.setVisibility(View.VISIBLE);
+ } else {
+ if (animate) {
+ mProgressContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_in));
+ mContentContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_out));
+ } else {
+ mProgressContainer.clearAnimation();
+ mContentContainer.clearAnimation();
+ }
+ mProgressContainer.setVisibility(View.VISIBLE);
+ mContentContainer.setVisibility(View.GONE);
+ }
+ }
+
+ /**
+ * Returns true if content is empty. The default content is not empty.
+ *
+ * @return true if content is null or empty
+ * @see #setContentEmpty(boolean)
+ */
+ public boolean isContentEmpty() {
+ return mIsContentEmpty;
+ }
+
+ /**
+ * If the content is empty, then set true otherwise false. The default content is not empty.
+ * You can't call this method if the content view has not been initialized before
+ * {@link #setContentView(View)} and content view not null.
+ *
+ * @param isEmpty true if content is empty else false
+ * @see #isContentEmpty()
+ */
+ public void setContentEmpty(boolean isEmpty) {
+ ensureContent();
+ if (mContentView == null) {
+ throw new IllegalStateException("Content view must be initialized before");
+ }
+ if (isEmpty) {
+ mEmptyView.setVisibility(View.VISIBLE);
+ mContentView.setVisibility(View.GONE);
+ } else {
+ mEmptyView.setVisibility(View.GONE);
+ mContentView.setVisibility(View.VISIBLE);
+ }
+ mIsContentEmpty = isEmpty;
+ }
+
+ public void hideProgress(boolean isEmpty) {
+ setContentEmpty(isEmpty);
+ setContentShown(true);
+ }
+
+ public void showProgress() {
+ setContentShown(false);
+ }
+
+ /**
+ * Initialization views.
+ */
+ private void ensureContent() {
+ if (mHeaderContainer != null && mContentContainer != null && mProgressContainer != null) {
+ return;
+ }
+ View root = getView();
+ if (root == null) {
+ throw new IllegalStateException("Content view not yet created");
+ }
+ mHeaderContainer = root.findViewById(R.id.header_container);
+ if (mHeaderContainer == null) {
+ throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.header_container'");
+ }
+ mProgressContainer = root.findViewById(R.id.progress_container);
+ if (mProgressContainer == null) {
+ throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.progress_container'");
+ }
+ mContentContainer = root.findViewById(R.id.content_container);
+ if (mContentContainer == null) {
+ throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.content_container'");
+ }
+ mEmptyView = root.findViewById(android.R.id.empty);
+ if (mEmptyView != null) {
+ mEmptyView.setVisibility(View.GONE);
+ }
+ mContentShown = true;
+ // We are starting without a content, so assume we won't
+ // have our data right away and start with the progress indicator.
+ if (mContentView == null) {
+ setContentShown(false, false);
+ }
+ }
+
+}
diff --git a/progressfragment-sample/res/layout/view_header.xml b/progressfragment-sample/res/layout/view_header.xml
new file mode 100644
index 0000000..b0edb3e
--- /dev/null
+++ b/progressfragment-sample/res/layout/view_header.xml
@@ -0,0 +1,20 @@
+
+
If you are overriding this method with your own custom content, + * consider including the standard layout {@link com.devspark.progressfragment.R.layout#fragment_progress} + * in your layout file, so that you continue to retain all of the standard + * behavior of ProgressFragment. In particular, this is currently the only + * way to have the built-in indeterminant progress state be shown. + */ + @Override + public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { + return inflater.inflate(R.layout.fragment_dialog_progress, container, false); + } + + /** + * Attach to view once the view hierarchy has been created. + */ + @Override + public void onViewCreated(View view, Bundle savedInstanceState) { + super.onViewCreated(view, savedInstanceState); + ensureContent(); + } + + /** + * Detach from view. + */ + @Override + public void onDestroyView() { + mContentShown = false; + mIsContentEmpty = false; + mHeaderContainer = mHeaderView = null; + mProgressContainer = mContentContainer = mContentView = mEmptyView = null; + super.onDestroyView(); + } + + /** + * Return header view or null if the header view has not been initialized. + * + * @return header view or null + * @see #setHeaderView(android.view.View) + * @see #setHeaderView(int) + */ + public View getHeaderView() { + return mHeaderView; + } + + /** + * Set the header content from a layout resource. + * + * @param layoutResId Resource ID to be inflated. + * @see #setHeaderView(android.view.View) + * @see #getHeaderView() + */ + public void setHeaderView(int layoutResId) { + LayoutInflater layoutInflater = LayoutInflater.from(getActivity()); + View headerView = layoutInflater.inflate(layoutResId, null); + setHeaderView(headerView); + } + + /** + * Set the header view to an explicit view. If the header view was installed earlier, + * the content will be replaced with a new view. + * + * @param view The desired header to display. Value can't be null. + * @see #setHeaderView(int) + * @see #getHeaderView() + */ + public void setHeaderView(View view) { + ensureContent(); + if (view == null) { + throw new IllegalArgumentException("Content view can't be null"); + } + if (mHeaderContainer instanceof ViewGroup) { + ViewGroup contentContainer = (ViewGroup) mHeaderContainer; + if (mHeaderView == null) { + contentContainer.addView(view); + } else { + int index = contentContainer.indexOfChild(mHeaderView); + // replace content view + contentContainer.removeView(mHeaderView); + contentContainer.addView(view, index); + } + mHeaderView = view; + } else { + throw new IllegalStateException("Can't be used with a custom content view"); + } + } + + /** + * Return content view or null if the content view has not been initialized. + * + * @return content view or null + * @see #setContentView(android.view.View) + * @see #setContentView(int) + */ + public View getContentView() { + return mContentView; + } + + /** + * Set the content content from a layout resource. + * + * @param layoutResId Resource ID to be inflated. + * @see #setContentView(android.view.View) + * @see #getContentView() + */ + public void setContentView(int layoutResId) { + LayoutInflater layoutInflater = LayoutInflater.from(getActivity()); + View contentView = layoutInflater.inflate(layoutResId, null); + setContentView(contentView); + } + + /** + * Set the content view to an explicit view. If the content view was installed earlier, + * the content will be replaced with a new view. + * + * @param view The desired content to display. Value can't be null. + * @see #setContentView(int) + * @see #getContentView() + */ + public void setContentView(View view) { + ensureContent(); + if (view == null) { + throw new IllegalArgumentException("Content view can't be null"); + } + if (mContentContainer instanceof ViewGroup) { + ViewGroup contentContainer = (ViewGroup) mContentContainer; + if (mContentView == null) { + contentContainer.addView(view); + } else { + int index = contentContainer.indexOfChild(mContentView); + // replace content view + contentContainer.removeView(mContentView); + contentContainer.addView(view, index); + } + mContentView = view; + } else { + throw new IllegalStateException("Can't be used with a custom content view"); + } + } + + /** + * The default content for a ProgressFragment has a TextView that can be shown when + * the content is empty {@link #setContentEmpty(boolean)}. + * If you would like to have it shown, call this method to supply the text it should use. + * + * @param resId Identification of string from a resources + * @see #setEmptyText(CharSequence) + */ + public void setEmptyText(int resId) { + setEmptyText(getString(resId)); + } + + /** + * The default content for a ProgressFragment has a TextView that can be shown when + * the content is empty {@link #setContentEmpty(boolean)}. + * If you would like to have it shown, call this method to supply the text it should use. + * + * @param text Text for empty view + * @see #setEmptyText(int) + */ + public void setEmptyText(CharSequence text) { + ensureContent(); + if (mEmptyView != null && mEmptyView instanceof TextView) { + ((TextView) mEmptyView).setText(text); + } else { + throw new IllegalStateException("Can't be used with a custom content view"); + } + } + + /** + * Control whether the content is being displayed. You can make it not + * displayed if you are waiting for the initial data to show in it. During + * this time an indeterminant progress indicator will be shown instead. + * + * @param shown If true, the content view is shown; if false, the progress + * indicator. The initial value is true. + * @see #setContentShownNoAnimation(boolean) + */ + public void setContentShown(boolean shown) { + setContentShown(shown, true); + } + + /** + * Like {@link #setContentShown(boolean)}, but no animation is used when + * transitioning from the previous state. + * + * @param shown If true, the content view is shown; if false, the progress + * indicator. The initial value is true. + * @see #setContentShown(boolean) + */ + public void setContentShownNoAnimation(boolean shown) { + setContentShown(shown, false); + } + + /** + * Control whether the content is being displayed. You can make it not + * displayed if you are waiting for the initial data to show in it. During + * this time an indeterminant progress indicator will be shown instead. + * + * @param shown If true, the content view is shown; if false, the progress + * indicator. The initial value is true. + * @param animate If true, an animation will be used to transition to the + * new state. + */ + private void setContentShown(boolean shown, boolean animate) { + ensureContent(); + if (mContentShown == shown) { + return; + } + if (mProgressContainer == null || mContentContainer == null) { + return; + } + mContentShown = shown; + if (shown) { + if (animate) { + mProgressContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_out)); + mContentContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_in)); + } else { + mProgressContainer.clearAnimation(); + mContentContainer.clearAnimation(); + } + mProgressContainer.setVisibility(View.GONE); + mContentContainer.setVisibility(View.VISIBLE); + } else { + if (animate) { + mProgressContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_in)); + mContentContainer.startAnimation(AnimationUtils.loadAnimation(getActivity(), android.R.anim.fade_out)); + } else { + mProgressContainer.clearAnimation(); + mContentContainer.clearAnimation(); + } + mProgressContainer.setVisibility(View.VISIBLE); + mContentContainer.setVisibility(View.GONE); + } + } + + /** + * Returns true if content is empty. The default content is not empty. + * + * @return true if content is null or empty + * @see #setContentEmpty(boolean) + */ + public boolean isContentEmpty() { + return mIsContentEmpty; + } + + /** + * If the content is empty, then set true otherwise false. The default content is not empty. + * You can't call this method if the content view has not been initialized before + * {@link #setContentView(android.view.View)} and content view not null. + * + * @param isEmpty true if content is empty else false + * @see #isContentEmpty() + */ + public void setContentEmpty(boolean isEmpty) { + ensureContent(); + if (mContentView == null) { + throw new IllegalStateException("Content view must be initialized before"); + } + if (isEmpty) { + mEmptyView.setVisibility(View.VISIBLE); + mContentView.setVisibility(View.GONE); + } else { + mEmptyView.setVisibility(View.GONE); + mContentView.setVisibility(View.VISIBLE); + } + mIsContentEmpty = isEmpty; + } + + public void hideProgress(boolean isEmpty) { + setContentEmpty(isEmpty); + setContentShown(true); + } + + public void showProgress() { + setContentShown(false); + } + + /** + * Initialization views. + */ + private void ensureContent() { + if (mHeaderContainer != null && mContentContainer != null && mProgressContainer != null) { + return; + } + View root = getView(); + if (root == null) { + throw new IllegalStateException("Content view not yet created"); + } + mHeaderContainer = root.findViewById(R.id.header_container); + if (mHeaderContainer == null) { + throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.header_container'"); + } + mProgressContainer = root.findViewById(R.id.progress_container); + if (mProgressContainer == null) { + throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.progress_container'"); + } + mContentContainer = root.findViewById(R.id.content_container); + if (mContentContainer == null) { + throw new RuntimeException("Your content must have a ViewGroup whose id attribute is 'R.id.content_container'"); + } + mEmptyView = root.findViewById(android.R.id.empty); + if (mEmptyView != null) { + mEmptyView.setVisibility(View.GONE); + } + mContentShown = true; + // We are starting without a content, so assume we won't + // have our data right away and start with the progress indicator. + if (mContentView == null) { + setContentShown(false, false); + } + } + +}