SetupWizardLayout.java revision 6cd984308b537924865bde77c2ee13d072cd9a48
1/* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package com.android.setupwizardlib; 18 19import android.annotation.SuppressLint; 20import android.annotation.TargetApi; 21import android.content.Context; 22import android.content.res.ColorStateList; 23import android.content.res.TypedArray; 24import android.graphics.Shader.TileMode; 25import android.graphics.drawable.BitmapDrawable; 26import android.graphics.drawable.Drawable; 27import android.graphics.drawable.LayerDrawable; 28import android.os.Build; 29import android.os.Build.VERSION; 30import android.os.Build.VERSION_CODES; 31import android.os.Parcel; 32import android.os.Parcelable; 33import android.util.AttributeSet; 34import android.util.Log; 35import android.util.TypedValue; 36import android.view.Gravity; 37import android.view.LayoutInflater; 38import android.view.View; 39import android.view.ViewGroup; 40import android.view.ViewStub; 41import android.widget.ProgressBar; 42import android.widget.ScrollView; 43import android.widget.TextView; 44 45import com.android.setupwizardlib.util.RequireScrollHelper; 46import com.android.setupwizardlib.view.BottomScrollView; 47import com.android.setupwizardlib.view.Illustration; 48import com.android.setupwizardlib.view.NavigationBar; 49 50public class SetupWizardLayout extends TemplateLayout { 51 52 private static final String TAG = "SetupWizardLayout"; 53 54 private ColorStateList mProgressBarColor; 55 56 public SetupWizardLayout(Context context) { 57 super(context, 0, 0); 58 init(null, R.attr.suwLayoutTheme); 59 } 60 61 public SetupWizardLayout(Context context, int template) { 62 this(context, template, 0); 63 } 64 65 public SetupWizardLayout(Context context, int template, int containerId) { 66 super(context, template, containerId); 67 init(null, R.attr.suwLayoutTheme); 68 } 69 70 public SetupWizardLayout(Context context, AttributeSet attrs) { 71 super(context, attrs); 72 init(attrs, R.attr.suwLayoutTheme); 73 } 74 75 @TargetApi(VERSION_CODES.HONEYCOMB) 76 public SetupWizardLayout(Context context, AttributeSet attrs, int defStyleAttr) { 77 super(context, attrs, defStyleAttr); 78 init(attrs, defStyleAttr); 79 } 80 81 // All the constructors delegate to this init method. The 3-argument constructor is not 82 // available in LinearLayout before v11, so call super with the exact same arguments. 83 private void init(AttributeSet attrs, int defStyleAttr) { 84 final TypedArray a = getContext().obtainStyledAttributes(attrs, 85 R.styleable.SuwSetupWizardLayout, defStyleAttr, 0); 86 87 // Set the background from XML, either directly or built from a bitmap tile 88 final Drawable background = 89 a.getDrawable(R.styleable.SuwSetupWizardLayout_suwBackground); 90 if (background != null) { 91 setLayoutBackground(background); 92 } else { 93 final Drawable backgroundTile = 94 a.getDrawable(R.styleable.SuwSetupWizardLayout_suwBackgroundTile); 95 if (backgroundTile != null) { 96 setBackgroundTile(backgroundTile); 97 } 98 } 99 100 // Set the illustration from XML, either directly or built from image + horizontal tile 101 final Drawable illustration = 102 a.getDrawable(R.styleable.SuwSetupWizardLayout_suwIllustration); 103 if (illustration != null) { 104 setIllustration(illustration); 105 } else { 106 final Drawable illustrationImage = 107 a.getDrawable(R.styleable.SuwSetupWizardLayout_suwIllustrationImage); 108 final Drawable horizontalTile = a.getDrawable( 109 R.styleable.SuwSetupWizardLayout_suwIllustrationHorizontalTile); 110 if (illustrationImage != null && horizontalTile != null) { 111 setIllustration(illustrationImage, horizontalTile); 112 } 113 } 114 115 // Set the top padding of the illustration 116 int decorPaddingTop = a.getDimensionPixelSize( 117 R.styleable.SuwSetupWizardLayout_suwDecorPaddingTop, -1); 118 if (decorPaddingTop == -1) { 119 decorPaddingTop = getResources().getDimensionPixelSize(R.dimen.suw_decor_padding_top); 120 } 121 setDecorPaddingTop(decorPaddingTop); 122 123 124 // Set the illustration aspect ratio. See Illustration.setAspectRatio(float). This will 125 // override suwIllustrationPaddingTop if its value is not 0. 126 float illustrationAspectRatio = a.getFloat( 127 R.styleable.SuwSetupWizardLayout_suwIllustrationAspectRatio, -1f); 128 if (illustrationAspectRatio == -1f) { 129 final TypedValue out = new TypedValue(); 130 getResources().getValue(R.dimen.suw_illustration_aspect_ratio, out, true); 131 illustrationAspectRatio = out.getFloat(); 132 } 133 setIllustrationAspectRatio(illustrationAspectRatio); 134 135 // Set the header text 136 final CharSequence headerText = 137 a.getText(R.styleable.SuwSetupWizardLayout_suwHeaderText); 138 if (headerText != null) { 139 setHeaderText(headerText); 140 } 141 142 a.recycle(); 143 } 144 145 @Override 146 protected Parcelable onSaveInstanceState() { 147 final Parcelable parcelable = super.onSaveInstanceState(); 148 final SavedState ss = new SavedState(parcelable); 149 ss.mIsProgressBarShown = isProgressBarShown(); 150 return ss; 151 } 152 153 @Override 154 protected void onRestoreInstanceState(Parcelable state) { 155 final SavedState ss = (SavedState) state; 156 super.onRestoreInstanceState(ss.getSuperState()); 157 final boolean isProgressBarShown = ss.mIsProgressBarShown; 158 if (isProgressBarShown) { 159 showProgressBar(); 160 } else { 161 hideProgressBar(); 162 } 163 } 164 165 @Override 166 protected View onInflateTemplate(LayoutInflater inflater, int template) { 167 if (template == 0) { 168 template = R.layout.suw_template; 169 } 170 return super.onInflateTemplate(inflater, template); 171 } 172 173 @Override 174 protected ViewGroup findContainer(int containerId) { 175 if (containerId == 0) { 176 containerId = R.id.suw_layout_content; 177 } 178 return super.findContainer(containerId); 179 } 180 181 public NavigationBar getNavigationBar() { 182 final View view = findManagedViewById(R.id.suw_layout_navigation_bar); 183 return view instanceof NavigationBar ? (NavigationBar) view : null; 184 } 185 186 public ScrollView getScrollView() { 187 final View view = findManagedViewById(R.id.suw_bottom_scroll_view); 188 return view instanceof ScrollView ? (ScrollView) view : null; 189 } 190 191 public void requireScrollToBottom() { 192 final NavigationBar navigationBar = getNavigationBar(); 193 final ScrollView scrollView = getScrollView(); 194 if (navigationBar != null && (scrollView instanceof BottomScrollView)) { 195 RequireScrollHelper.requireScroll(navigationBar, (BottomScrollView) scrollView); 196 } else { 197 Log.e(TAG, "Both suw_layout_navigation_bar and suw_bottom_scroll_view must exist in" 198 + " the template to require scrolling."); 199 } 200 } 201 202 public void setHeaderText(int title) { 203 final TextView titleView = getHeaderTextView(); 204 if (titleView != null) { 205 titleView.setText(title); 206 } 207 } 208 209 public void setHeaderText(CharSequence title) { 210 final TextView titleView = getHeaderTextView(); 211 if (titleView != null) { 212 titleView.setText(title); 213 } 214 } 215 216 public CharSequence getHeaderText() { 217 final TextView titleView = getHeaderTextView(); 218 return titleView != null ? titleView.getText() : null; 219 } 220 221 public TextView getHeaderTextView() { 222 return (TextView) findManagedViewById(R.id.suw_layout_title); 223 } 224 225 /** 226 * Set the illustration of the layout. The drawable will be applied as is, and the bounds will 227 * be set as implemented in {@link com.android.setupwizardlib.view.Illustration}. To create 228 * a suitable drawable from an asset and a horizontal repeating tile, use 229 * {@link #setIllustration(int, int)} instead. 230 * 231 * @param drawable The drawable specifying the illustration. 232 */ 233 public void setIllustration(Drawable drawable) { 234 final View view = findManagedViewById(R.id.suw_layout_decor); 235 if (view instanceof Illustration) { 236 final Illustration illustration = (Illustration) view; 237 illustration.setIllustration(drawable); 238 } 239 } 240 241 /** 242 * Set the illustration of the layout, which will be created asset and the horizontal tile as 243 * suitable. On phone layouts (not sw600dp), the asset will be scaled, maintaining aspect ratio. 244 * On tablets (sw600dp), the assets will always have 256dp height and the rest of the 245 * illustration area that the asset doesn't fill will be covered by the horizontalTile. 246 * 247 * @param asset Resource ID of the illustration asset. 248 * @param horizontalTile Resource ID of the horizontally repeating tile for tablet layout. 249 */ 250 public void setIllustration(int asset, int horizontalTile) { 251 final View view = findManagedViewById(R.id.suw_layout_decor); 252 if (view instanceof Illustration) { 253 final Illustration illustration = (Illustration) view; 254 final Drawable illustrationDrawable = getIllustration(asset, horizontalTile); 255 illustration.setIllustration(illustrationDrawable); 256 } 257 } 258 259 private void setIllustration(Drawable asset, Drawable horizontalTile) { 260 final View view = findManagedViewById(R.id.suw_layout_decor); 261 if (view instanceof Illustration) { 262 final Illustration illustration = (Illustration) view; 263 final Drawable illustrationDrawable = getIllustration(asset, horizontalTile); 264 illustration.setIllustration(illustrationDrawable); 265 } 266 } 267 268 /** 269 * Sets the aspect ratio of the illustration. This will be the space (padding top) reserved 270 * above the header text. This will override the padding top of the illustration. 271 * 272 * @param aspectRatio The aspect ratio 273 * @see com.android.setupwizardlib.view.Illustration#setAspectRatio(float) 274 */ 275 public void setIllustrationAspectRatio(float aspectRatio) { 276 final View view = findManagedViewById(R.id.suw_layout_decor); 277 if (view instanceof Illustration) { 278 final Illustration illustration = (Illustration) view; 279 illustration.setAspectRatio(aspectRatio); 280 } 281 } 282 283 /** 284 * Set the top padding of the decor view. If the decor is an Illustration and the aspect ratio 285 * is set, this value will be overridden. 286 * 287 * <p>Note: Currently the default top padding for tablet landscape is 128dp, which is the offset 288 * of the card from the top. This is likely to change in future versions so this value aligns 289 * with the height of the illustration instead. 290 * 291 * @param paddingTop The top padding in pixels. 292 */ 293 public void setDecorPaddingTop(int paddingTop) { 294 final View view = findManagedViewById(R.id.suw_layout_decor); 295 if (view != null) { 296 view.setPadding(view.getPaddingLeft(), paddingTop, view.getPaddingRight(), 297 view.getPaddingBottom()); 298 } 299 } 300 301 /** 302 * Set the background of the layout, which is expected to be able to extend infinitely. If it is 303 * a bitmap tile and you want it to repeat, use {@link #setBackgroundTile(int)} instead. 304 */ 305 public void setLayoutBackground(Drawable background) { 306 final View view = findManagedViewById(R.id.suw_layout_decor); 307 if (view != null) { 308 //noinspection deprecation 309 view.setBackgroundDrawable(background); 310 } 311 } 312 313 /** 314 * Set the background of the layout to a repeating bitmap tile. To use a different kind of 315 * drawable, use {@link #setLayoutBackground(android.graphics.drawable.Drawable)} instead. 316 */ 317 public void setBackgroundTile(int backgroundTile) { 318 final Drawable backgroundTileDrawable = 319 getContext().getResources().getDrawable(backgroundTile); 320 setBackgroundTile(backgroundTileDrawable); 321 } 322 323 private void setBackgroundTile(Drawable backgroundTile) { 324 if (backgroundTile instanceof BitmapDrawable) { 325 ((BitmapDrawable) backgroundTile).setTileModeXY(TileMode.REPEAT, TileMode.REPEAT); 326 } 327 setLayoutBackground(backgroundTile); 328 } 329 330 private Drawable getIllustration(int asset, int horizontalTile) { 331 final Context context = getContext(); 332 final Drawable assetDrawable = context.getResources().getDrawable(asset); 333 final Drawable tile = context.getResources().getDrawable(horizontalTile); 334 return getIllustration(assetDrawable, tile); 335 } 336 337 @SuppressLint("RtlHardcoded") 338 private Drawable getIllustration(Drawable asset, Drawable horizontalTile) { 339 final Context context = getContext(); 340 if (context.getResources().getBoolean(R.bool.suwUseTabletLayout)) { 341 // If it is a "tablet" (sw600dp), create a LayerDrawable with the horizontal tile. 342 if (horizontalTile instanceof BitmapDrawable) { 343 ((BitmapDrawable) horizontalTile).setTileModeX(TileMode.REPEAT); 344 ((BitmapDrawable) horizontalTile).setGravity(Gravity.TOP); 345 } 346 if (asset instanceof BitmapDrawable) { 347 // Always specify TOP | LEFT, Illustration will flip the entire LayerDrawable. 348 ((BitmapDrawable) asset).setGravity(Gravity.TOP | Gravity.LEFT); 349 } 350 final LayerDrawable layers = 351 new LayerDrawable(new Drawable[] { horizontalTile, asset }); 352 if (VERSION.SDK_INT >= VERSION_CODES.KITKAT) { 353 layers.setAutoMirrored(true); 354 } 355 return layers; 356 } else { 357 // If it is a "phone" (not sw600dp), simply return the illustration 358 if (VERSION.SDK_INT >= VERSION_CODES.KITKAT) { 359 asset.setAutoMirrored(true); 360 } 361 return asset; 362 } 363 } 364 365 /** 366 * Same as {@link android.view.View#findViewById(int)}, but may include views that are managed 367 * by this view but not currently added to the view hierarchy. e.g. recycler view or list view 368 * headers that are not currently shown. 369 */ 370 protected View findManagedViewById(int id) { 371 return findViewById(id); 372 } 373 374 public boolean isProgressBarShown() { 375 final View progressBar = findManagedViewById(R.id.suw_layout_progress); 376 return progressBar != null && progressBar.getVisibility() == View.VISIBLE; 377 } 378 379 /** 380 * Sets whether the progress bar below the header text is shown or not. The progress bar is 381 * a lazily inflated ViewStub, which means the progress bar will not actually be part of the 382 * view hierarchy until the first time this is set to {@code true}. 383 */ 384 public void setProgressBarShown(boolean shown) { 385 final View progressBar = findManagedViewById(R.id.suw_layout_progress); 386 if (progressBar != null) { 387 progressBar.setVisibility(shown ? View.VISIBLE : View.GONE); 388 } else if (shown) { 389 final ViewStub progressBarStub = 390 (ViewStub) findManagedViewById(R.id.suw_layout_progress_stub); 391 if (progressBarStub != null) { 392 progressBarStub.inflate(); 393 } 394 if (mProgressBarColor != null) { 395 setProgressBarColor(mProgressBarColor); 396 } 397 } 398 } 399 400 /** 401 * @deprecated Use {@link #setProgressBarShown(boolean)} 402 */ 403 @Deprecated 404 public void showProgressBar() { 405 setProgressBarShown(true); 406 } 407 408 /** 409 * @deprecated Use {@link #setProgressBarShown(boolean)} 410 */ 411 @Deprecated 412 public void hideProgressBar() { 413 setProgressBarShown(false); 414 } 415 416 public void setProgressBarColor(ColorStateList color) { 417 mProgressBarColor = color; 418 if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) { 419 // Suppress lint error caused by 420 // https://code.google.com/p/android/issues/detail?id=183136 421 // noinspection AndroidLintWrongViewCast 422 final ProgressBar bar = (ProgressBar) findViewById(R.id.suw_layout_progress); 423 if (bar != null) { 424 bar.setIndeterminateTintList(color); 425 } 426 } 427 } 428 429 public ColorStateList getProgressBarColor() { 430 return mProgressBarColor; 431 } 432 433 /* Misc */ 434 435 protected static class SavedState extends BaseSavedState { 436 437 boolean mIsProgressBarShown = false; 438 439 public SavedState(Parcelable parcelable) { 440 super(parcelable); 441 } 442 443 public SavedState(Parcel source) { 444 super(source); 445 mIsProgressBarShown = source.readInt() != 0; 446 } 447 448 @Override 449 public void writeToParcel(Parcel dest, int flags) { 450 super.writeToParcel(dest, flags); 451 dest.writeInt(mIsProgressBarShown ? 1 : 0); 452 } 453 454 public static final Parcelable.Creator<SavedState> CREATOR = 455 new Parcelable.Creator<SavedState>() { 456 457 @Override 458 public SavedState createFromParcel(Parcel parcel) { 459 return new SavedState(parcel); 460 } 461 462 @Override 463 public SavedState[] newArray(int size) { 464 return new SavedState[size]; 465 } 466 }; 467 } 468} 469