MoreKeysPanel.java revision 0e08d70fe52737582b6c83dbf48aaf4d83063566
1ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka/* 2ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * Copyright (C) 2011 The Android Open Source Project 3ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * 4ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * Licensed under the Apache License, Version 2.0 (the "License"); 5ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * you may not use this file except in compliance with the License. 6ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * You may obtain a copy of the License at 7ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * 8ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * http://www.apache.org/licenses/LICENSE-2.0 9ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * 10ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * Unless required by applicable law or agreed to in writing, software 11ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * distributed under the License is distributed on an "AS IS" BASIS, 12ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * See the License for the specific language governing permissions and 14ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka * limitations under the License. 15ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka */ 16ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka 17ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaokapackage com.android.inputmethod.keyboard; 18ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka 19f44a01b40852dde2363a061cdc7df2ef4cb59aadTadashi G. Takaokaimport android.view.View; 20ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka 2135580bad6f3da3b204653825bbb6871563e70728Tom Ouyangpublic interface MoreKeysPanel { 22f44a01b40852dde2363a061cdc7df2ef4cb59aadTadashi G. Takaoka public interface Controller { 23fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang /** 24fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * Add the {@link MoreKeysPanel} to the target view. 250e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka * @param panel the panel to be shown. 26fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang */ 27fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang public void onShowMoreKeysPanel(final MoreKeysPanel panel); 28fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang 29fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang /** 3035580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * Remove the current {@link MoreKeysPanel} from the target view. 310e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka * @param panel the panel to be dismissed. 32fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang */ 330e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka public void onDismissMoreKeysPanel(final MoreKeysPanel panel); 34ac69ab400d1ea4f90b4ca24486d62212decf1069Tom Ouyang 35ac69ab400d1ea4f90b4ca24486d62212decf1069Tom Ouyang /** 36ac69ab400d1ea4f90b4ca24486d62212decf1069Tom Ouyang * Instructs the parent to cancel the panel (e.g., when entering a different input mode). 370e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka * @param panel the panel to be canceled. 38ac69ab400d1ea4f90b4ca24486d62212decf1069Tom Ouyang */ 390e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka public void onCancelMoreKeysPanel(final MoreKeysPanel panel); 40f44a01b40852dde2363a061cdc7df2ef4cb59aadTadashi G. Takaoka } 41f44a01b40852dde2363a061cdc7df2ef4cb59aadTadashi G. Takaoka 4209e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka public static final Controller EMPTY_CONTROLLER = new Controller() { 4309e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka @Override 4409e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka public void onShowMoreKeysPanel(final MoreKeysPanel panel) {} 4509e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka @Override 460e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka public void onDismissMoreKeysPanel(final MoreKeysPanel panel) {} 4709e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka @Override 480e08d70fe52737582b6c83dbf48aaf4d83063566Tadashi G. Takaoka public void onCancelMoreKeysPanel(final MoreKeysPanel panel) {} 4909e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka }; 5009e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka 51ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka /** 52fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * Initializes the layout and event handling of this {@link MoreKeysPanel} and calls the 53fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * controller's onShowMoreKeysPanel to add the panel's container view. 549d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * 55fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * @param parentView the parent view of this {@link MoreKeysPanel} 56fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * @param controller the controller that can dismiss this {@link MoreKeysPanel} 57fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * @param pointX x coordinate of this {@link MoreKeysPanel} 58fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * @param pointY y coordinate of this {@link MoreKeysPanel} 59fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * @param listener the listener that will receive keyboard action from this 60fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * {@link MoreKeysPanel}. 61fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang */ 62fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang // TODO: Currently the MoreKeysPanel is inside a container view that is added to the parent. 63fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang // Consider the simpler approach of placing the MoreKeysPanel itself into the parent view. 64fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang public void showMoreKeysPanel(View parentView, Controller controller, int pointX, 65fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang int pointY, KeyboardActionListener listener); 66fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang 67fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang /** 68fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * Dismisses the more keys panel and calls the controller's onDismissMoreKeysPanel to remove 69fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * the panel's container view. 70ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka */ 7109e4530ca75d4664eb72708face83b466839c522Tadashi G. Takaoka public void dismissMoreKeysPanel(); 72ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka 73ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka /** 7435580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * Process a move event on the more keys panel. 7535580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * 7635580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param x translated x coordinate of the touch point 7735580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param y translated y coordinate of the touch point 7835580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param pointerId pointer id touch point 7935580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param eventTime timestamp of touch point 8035580bad6f3da3b204653825bbb6871563e70728Tom Ouyang */ 8135580bad6f3da3b204653825bbb6871563e70728Tom Ouyang public void onMoveEvent(final int x, final int y, final int pointerId, final long eventTime); 8235580bad6f3da3b204653825bbb6871563e70728Tom Ouyang 8335580bad6f3da3b204653825bbb6871563e70728Tom Ouyang /** 8435580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * Process a down event on the more keys panel. 8535580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * 8635580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param x translated x coordinate of the touch point 8735580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param y translated y coordinate of the touch point 8835580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param pointerId pointer id touch point 8935580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param eventTime timestamp of touch point 9035580bad6f3da3b204653825bbb6871563e70728Tom Ouyang */ 9135580bad6f3da3b204653825bbb6871563e70728Tom Ouyang public void onDownEvent(final int x, final int y, final int pointerId, final long eventTime); 9235580bad6f3da3b204653825bbb6871563e70728Tom Ouyang 9335580bad6f3da3b204653825bbb6871563e70728Tom Ouyang /** 9435580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * Process an up event on the more keys panel. 9535580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * 9635580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param x translated x coordinate of the touch point 9735580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param y translated y coordinate of the touch point 9835580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param pointerId pointer id touch point 9935580bad6f3da3b204653825bbb6871563e70728Tom Ouyang * @param eventTime timestamp of touch point 10035580bad6f3da3b204653825bbb6871563e70728Tom Ouyang */ 10135580bad6f3da3b204653825bbb6871563e70728Tom Ouyang public void onUpEvent(final int x, final int y, final int pointerId, final long eventTime); 10235580bad6f3da3b204653825bbb6871563e70728Tom Ouyang 10335580bad6f3da3b204653825bbb6871563e70728Tom Ouyang /** 1049d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * Translate X-coordinate of touch event to the local X-coordinate of this 1059d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * {@link MoreKeysPanel}. 1069d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * 10763c233ab9f50d844be6e52e382c6664475606760Tadashi G. Takaoka * @param x the global X-coordinate 1089d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * @return the local X-coordinate to this {@link MoreKeysPanel} 109ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka */ 11063c233ab9f50d844be6e52e382c6664475606760Tadashi G. Takaoka public int translateX(int x); 111ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka 112ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka /** 1139d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * Translate Y-coordinate of touch event to the local Y-coordinate of this 1149d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * {@link MoreKeysPanel}. 1159d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * 11663c233ab9f50d844be6e52e382c6664475606760Tadashi G. Takaoka * @param y the global Y-coordinate 1179d5601e9013c5ec9a7ac75db16f4a0a8218b02bfTadashi G. Takaoka * @return the local Y-coordinate to this {@link MoreKeysPanel} 118ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka */ 11963c233ab9f50d844be6e52e382c6664475606760Tadashi G. Takaoka public int translateY(int y); 120fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang 121fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang /** 122fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * Return the view containing the more keys panel. 123fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang */ 124fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang public View getContainerView(); 125fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang 126fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang /** 127fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang * Return whether the panel is currently being shown. 128fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang */ 129fa2d543785c52f639ad3157c57420f58a199c550Tom Ouyang public boolean isShowingInParent(); 130ff082d081f3ea18ff0b9b22126ee4a86504cf83cTadashi G. Takaoka} 131