SetupWizardLayout.java revision bf4afac02228e42af171bbb5f3db11977be487b1
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 = (TextView) findManagedViewById(R.id.suw_layout_title); 204 if (titleView != null) { 205 titleView.setText(title); 206 } 207 } 208 209 public void setHeaderText(CharSequence title) { 210 final TextView titleView = (TextView) findManagedViewById(R.id.suw_layout_title); 211 if (titleView != null) { 212 titleView.setText(title); 213 } 214 } 215 216 public CharSequence getHeaderText() { 217 final TextView titleView = (TextView) findManagedViewById(R.id.suw_layout_title); 218 return titleView != null ? titleView.getText() : null; 219 } 220 221 /** 222 * Set the illustration of the layout. The drawable will be applied as is, and the bounds will 223 * be set as implemented in {@link com.android.setupwizardlib.view.Illustration}. To create 224 * a suitable drawable from an asset and a horizontal repeating tile, use 225 * {@link #setIllustration(int, int)} instead. 226 * 227 * @param drawable The drawable specifying the illustration. 228 */ 229 public void setIllustration(Drawable drawable) { 230 final View view = findManagedViewById(R.id.suw_layout_decor); 231 if (view instanceof Illustration) { 232 final Illustration illustration = (Illustration) view; 233 illustration.setIllustration(drawable); 234 } 235 } 236 237 /** 238 * Set the illustration of the layout, which will be created asset and the horizontal tile as 239 * suitable. On phone layouts (not sw600dp), the asset will be scaled, maintaining aspect ratio. 240 * On tablets (sw600dp), the assets will always have 256dp height and the rest of the 241 * illustration area that the asset doesn't fill will be covered by the horizontalTile. 242 * 243 * @param asset Resource ID of the illustration asset. 244 * @param horizontalTile Resource ID of the horizontally repeating tile for tablet layout. 245 */ 246 public void setIllustration(int asset, int horizontalTile) { 247 final View view = findManagedViewById(R.id.suw_layout_decor); 248 if (view instanceof Illustration) { 249 final Illustration illustration = (Illustration) view; 250 final Drawable illustrationDrawable = getIllustration(asset, horizontalTile); 251 illustration.setIllustration(illustrationDrawable); 252 } 253 } 254 255 private void setIllustration(Drawable asset, Drawable horizontalTile) { 256 final View view = findManagedViewById(R.id.suw_layout_decor); 257 if (view instanceof Illustration) { 258 final Illustration illustration = (Illustration) view; 259 final Drawable illustrationDrawable = getIllustration(asset, horizontalTile); 260 illustration.setIllustration(illustrationDrawable); 261 } 262 } 263 264 /** 265 * Sets the aspect ratio of the illustration. This will be the space (padding top) reserved 266 * above the header text. This will override the padding top of the illustration. 267 * 268 * @param aspectRatio The aspect ratio 269 * @see com.android.setupwizardlib.view.Illustration#setAspectRatio(float) 270 */ 271 public void setIllustrationAspectRatio(float aspectRatio) { 272 final View view = findManagedViewById(R.id.suw_layout_decor); 273 if (view instanceof Illustration) { 274 final Illustration illustration = (Illustration) view; 275 illustration.setAspectRatio(aspectRatio); 276 } 277 } 278 279 /** 280 * Set the top padding of the decor view. If the decor is an Illustration and the aspect ratio 281 * is set, this value will be overridden. 282 * 283 * <p>Note: Currently the default top padding for tablet landscape is 128dp, which is the offset 284 * of the card from the top. This is likely to change in future versions so this value aligns 285 * with the height of the illustration instead. 286 * 287 * @param paddingTop The top padding in pixels. 288 */ 289 public void setDecorPaddingTop(int paddingTop) { 290 final View view = findManagedViewById(R.id.suw_layout_decor); 291 if (view != null) { 292 view.setPadding(view.getPaddingLeft(), paddingTop, view.getPaddingRight(), 293 view.getPaddingBottom()); 294 } 295 } 296 297 /** 298 * Set the background of the layout, which is expected to be able to extend infinitely. If it is 299 * a bitmap tile and you want it to repeat, use {@link #setBackgroundTile(int)} instead. 300 */ 301 public void setLayoutBackground(Drawable background) { 302 final View view = findManagedViewById(R.id.suw_layout_decor); 303 if (view != null) { 304 //noinspection deprecation 305 view.setBackgroundDrawable(background); 306 } 307 } 308 309 /** 310 * Set the background of the layout to a repeating bitmap tile. To use a different kind of 311 * drawable, use {@link #setLayoutBackground(android.graphics.drawable.Drawable)} instead. 312 */ 313 public void setBackgroundTile(int backgroundTile) { 314 final Drawable backgroundTileDrawable = 315 getContext().getResources().getDrawable(backgroundTile); 316 setBackgroundTile(backgroundTileDrawable); 317 } 318 319 private void setBackgroundTile(Drawable backgroundTile) { 320 if (backgroundTile instanceof BitmapDrawable) { 321 ((BitmapDrawable) backgroundTile).setTileModeXY(TileMode.REPEAT, TileMode.REPEAT); 322 } 323 setLayoutBackground(backgroundTile); 324 } 325 326 private Drawable getIllustration(int asset, int horizontalTile) { 327 final Context context = getContext(); 328 final Drawable assetDrawable = context.getResources().getDrawable(asset); 329 final Drawable tile = context.getResources().getDrawable(horizontalTile); 330 return getIllustration(assetDrawable, tile); 331 } 332 333 @SuppressLint("RtlHardcoded") 334 private Drawable getIllustration(Drawable asset, Drawable horizontalTile) { 335 final Context context = getContext(); 336 if (context.getResources().getBoolean(R.bool.suwUseTabletLayout)) { 337 // If it is a "tablet" (sw600dp), create a LayerDrawable with the horizontal tile. 338 if (horizontalTile instanceof BitmapDrawable) { 339 ((BitmapDrawable) horizontalTile).setTileModeX(TileMode.REPEAT); 340 ((BitmapDrawable) horizontalTile).setGravity(Gravity.TOP); 341 } 342 if (asset instanceof BitmapDrawable) { 343 // Always specify TOP | LEFT, Illustration will flip the entire LayerDrawable. 344 ((BitmapDrawable) asset).setGravity(Gravity.TOP | Gravity.LEFT); 345 } 346 final LayerDrawable layers = 347 new LayerDrawable(new Drawable[] { horizontalTile, asset }); 348 if (VERSION.SDK_INT >= VERSION_CODES.KITKAT) { 349 layers.setAutoMirrored(true); 350 } 351 return layers; 352 } else { 353 // If it is a "phone" (not sw600dp), simply return the illustration 354 if (VERSION.SDK_INT >= VERSION_CODES.KITKAT) { 355 asset.setAutoMirrored(true); 356 } 357 return asset; 358 } 359 } 360 361 /** 362 * Same as {@link android.view.View#findViewById(int)}, but may include views that are managed 363 * by this view but not currently added to the view hierarchy. e.g. recycler view or list view 364 * headers that are not currently shown. 365 */ 366 protected View findManagedViewById(int id) { 367 return findViewById(id); 368 } 369 370 public boolean isProgressBarShown() { 371 final View progressBar = findManagedViewById(R.id.suw_layout_progress); 372 return progressBar != null && progressBar.getVisibility() == View.VISIBLE; 373 } 374 375 /** 376 * Sets whether the progress bar below the header text is shown or not. The progress bar is 377 * a lazily inflated ViewStub, which means the progress bar will not actually be part of the 378 * view hierarchy until the first time this is set to {@code true}. 379 */ 380 public void setProgressBarShown(boolean shown) { 381 final View progressBar = findManagedViewById(R.id.suw_layout_progress); 382 if (progressBar != null) { 383 progressBar.setVisibility(shown ? View.VISIBLE : View.GONE); 384 } else if (shown) { 385 final ViewStub progressBarStub = 386 (ViewStub) findManagedViewById(R.id.suw_layout_progress_stub); 387 if (progressBarStub != null) { 388 progressBarStub.inflate(); 389 } 390 if (mProgressBarColor != null) { 391 setProgressBarColor(mProgressBarColor); 392 } 393 } 394 } 395 396 /** 397 * @deprecated Use {@link #setProgressBarShown(boolean)} 398 */ 399 @Deprecated 400 public void showProgressBar() { 401 setProgressBarShown(true); 402 } 403 404 /** 405 * @deprecated Use {@link #setProgressBarShown(boolean)} 406 */ 407 @Deprecated 408 public void hideProgressBar() { 409 setProgressBarShown(false); 410 } 411 412 public void setProgressBarColor(ColorStateList color) { 413 mProgressBarColor = color; 414 if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) { 415 // Suppress lint error caused by 416 // https://code.google.com/p/android/issues/detail?id=183136 417 // noinspection AndroidLintWrongViewCast 418 final ProgressBar bar = (ProgressBar) findViewById(R.id.suw_layout_progress); 419 if (bar != null) { 420 bar.setIndeterminateTintList(color); 421 } 422 } 423 } 424 425 public ColorStateList getProgressBarColor() { 426 return mProgressBarColor; 427 } 428 429 /* Misc */ 430 431 protected static class SavedState extends BaseSavedState { 432 433 boolean mIsProgressBarShown = false; 434 435 public SavedState(Parcelable parcelable) { 436 super(parcelable); 437 } 438 439 public SavedState(Parcel source) { 440 super(source); 441 mIsProgressBarShown = source.readInt() != 0; 442 } 443 444 @Override 445 public void writeToParcel(Parcel dest, int flags) { 446 super.writeToParcel(dest, flags); 447 dest.writeInt(mIsProgressBarShown ? 1 : 0); 448 } 449 450 public static final Parcelable.Creator<SavedState> CREATOR = 451 new Parcelable.Creator<SavedState>() { 452 453 @Override 454 public SavedState createFromParcel(Parcel parcel) { 455 return new SavedState(parcel); 456 } 457 458 @Override 459 public SavedState[] newArray(int size) { 460 return new SavedState[size]; 461 } 462 }; 463 } 464} 465