NinePatch.java revision 54285f2cbfb6e307d594ca264f7230b4e1e3cdce
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.graphics; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The NinePatch class permits drawing a bitmap in nine sections. 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The four corners are unscaled; the four edges are scaled in one axis, 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and the middle is scaled in both axes. Normally, the middle is 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * transparent so that the patch can provide a selection about a rectangle. 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Essentially, it allows the creation of custom graphics that will scale the 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * way that you define, when content added within the image exceeds the normal 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * bounds of the graphic. For a thorough explanation of a NinePatch image, 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * read the discussion in the 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/graphics/2d-graphics.html#nine-patch">2D 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Graphics</a> document. 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The <a href="{@docRoot}guide/developing/tools/draw9patch.html">Draw 9-Patch</a> 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tool offers an extremely handy way to create your NinePatch images, 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a WYSIWYG graphics editor. 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </p> 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class NinePatch { 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a drawable projection from a bitmap to nine patches. 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param bitmap The bitmap describing the patches. 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param chunk The 9-patch data chunk describing how the underlying 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * bitmap is split apart and drawn. 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param srcName The name of the source for the bitmap. Might be null. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public NinePatch(Bitmap bitmap, byte[] chunk, String srcName) { 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBitmap = bitmap; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mChunk = chunk; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSrcName = srcName; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project validateNinePatchChunk(mBitmap.ni(), chunk); 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public NinePatch(NinePatch patch) { 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBitmap = patch.mBitmap; 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mChunk = patch.mChunk; 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSrcName = patch.mSrcName; 6054285f2cbfb6e307d594ca264f7230b4e1e3cdcePhil Dubach if (patch.mPaint != null) { 6154285f2cbfb6e307d594ca264f7230b4e1e3cdcePhil Dubach mPaint = new Paint(patch.mPaint); 6254285f2cbfb6e307d594ca264f7230b4e1e3cdcePhil Dubach } 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project validateNinePatchChunk(mBitmap.ni(), mChunk); 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setPaint(Paint p) { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPaint = p; 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Draw a bitmap to nine patches. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param canvas A container for the current matrix and clip used to draw the bitmap. 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param location Where to draw the bitmap. 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void draw(Canvas canvas, RectF location) { 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeDraw(canvas.mNativeCanvas, location, 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBitmap.ni(), mChunk, 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPaint != null ? mPaint.mNativePaint : 0); 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Draw a bitmap to nine patches. 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param canvas A container for the current matrix and clip used to draw the bitmap. 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param location Where to draw the bitmap. 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void draw(Canvas canvas, Rect location) { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeDraw(canvas.mNativeCanvas, location, 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBitmap.ni(), mChunk, 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPaint != null ? mPaint.mNativePaint : 0); 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Draw a bitmap to nine patches. 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param canvas A container for the current matrix and clip used to draw the bitmap. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param location Where to draw the bitmap. 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param paint The Paint to draw through. 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void draw(Canvas canvas, Rect location, Paint paint) { 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeDraw(canvas.mNativeCanvas, location, 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBitmap.ni(), mChunk, paint != null ? paint.mNativePaint : 0); 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getWidth() { 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mBitmap.getWidth(); 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getHeight() { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mBitmap.getHeight(); 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasAlpha() { 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mBitmap.hasAlpha(); 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Region getTransparentRegion(Rect location) { 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int r = nativeGetTransparentRegion(mBitmap.ni(), mChunk, location); 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return r != 0 ? new Region(r) : null; 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public native static boolean isNinePatchChunk(byte[] chunk); 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final Bitmap mBitmap; 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final byte[] mChunk; 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Paint mPaint; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String mSrcName; // Useful for debugging 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void validateNinePatchChunk(int bitmap, byte[] chunk); 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeDraw(int canvas_instance, RectF loc, int bitmap_instance, 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project byte[] c, int paint_instance_or_null); 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeDraw(int canvas_instance, Rect loc, int bitmap_instance, 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project byte[] c, int paint_instance_or_null); 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native int nativeGetTransparentRegion( 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int bitmap, byte[] chunk, Rect location); 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 138