StateSet.java revision 9066cfe9886ac131c34d59ed0e2d287b0e3c0087
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 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.util; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport com.android.internal.R; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * State sets are arrays of positive ints where each element 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * represents the state of a {@link android.view.View} (e.g. focused, 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * selected, visible, etc.). A {@link android.view.View} may be in 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one or more of those states. 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A state spec is an array of signed ints where each element 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * represents a required (if positive) or an undesired (if negative) 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.view.View} state. 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Utils dealing with state sets. 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * In theory we could encapsulate the state set and state spec arrays 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and not have static methods here but there is some concern about 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * performance since these methods are called during view drawing. 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class StateSet { 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int[] WILD_CARD = new int[0]; 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the stateSetOrSpec is matched by all StateSets. 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param stateSetOrSpec a state set or state spec. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean isWildCard(int[] stateSetOrSpec) { 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return stateSetOrSpec.length == 0 || stateSetOrSpec[0] == 0; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the stateSet matches the desired stateSpec. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param stateSpec an array of required (if positive) or 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * prohibited (if negative) {@link android.view.View} states. 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param stateSet an array of {@link android.view.View} states 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean stateSetMatches(int[] stateSpec, int[] stateSet) { 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (stateSet == null) { 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return (stateSpec == null || isWildCard(stateSpec)); 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int stateSpecSize = stateSpec.length; 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int stateSetSize = stateSet.length; 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < stateSpecSize; i++) { 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int stateSpecState = stateSpec[i]; 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (stateSpecState == 0) { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We've reached the end of the cases to match against. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final boolean mustMatch; 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (stateSpecState > 0) { 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mustMatch = true; 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We use negative values to indicate must-NOT-match states. 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mustMatch = false; 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project stateSpecState = -stateSpecState; 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean found = false; 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int j = 0; j < stateSetSize; j++) { 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int state = stateSet[j]; 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state == 0) { 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We've reached the end of states to match. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mustMatch) { 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We didn't find this must-match state. 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Continue checking other must-not-match states. 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state == stateSpecState) { 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mustMatch) { 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project found = true; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Continue checking other other must-match states. 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Any match of a must-not-match state returns false. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mustMatch && !found) { 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We've reached the end of states to match and we didn't 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // find a must-match state. 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the state matches the desired stateSpec. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param stateSpec an array of required (if positive) or 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * prohibited (if negative) {@link android.view.View} states. 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param state a {@link android.view.View} state 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean stateSetMatches(int[] stateSpec, int state) { 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int stateSpecSize = stateSpec.length; 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < stateSpecSize; i++) { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int stateSpecState = stateSpec[i]; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (stateSpecState == 0) { 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We've reached the end of the cases to match against. 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (stateSpecState > 0) { 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state != stateSpecState) { 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We use negative values to indicate must-NOT-match states. 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state == -stateSpecState) { 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We matched a must-not-match case. 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int[] trimStateSet(int[] states, int newSize) { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (states.length == newSize) { 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return states; 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int[] trimmedStates = new int[newSize]; 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project System.arraycopy(states, 0, trimmedStates, 0, newSize); 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return trimmedStates; 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static String dump(int[] states) { 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder sb = new StringBuilder(); 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int count = states.length; 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < count; i++) { 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project switch (states[i]) { 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case R.attr.state_window_focused: 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append("W "); 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case R.attr.state_pressed: 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append("P "); 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case R.attr.state_selected: 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append("S "); 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case R.attr.state_focused: 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append("F "); 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case R.attr.state_enabled: 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append("E "); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sb.toString(); 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 179