/TalkBack/src/com/google/android/marvin/talkback/speechrules/NodeSpeechRule.java

 1/*
 2 * Copyright (C) 2011 The Android Open Source Project
 3 *
 4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 5 * use this file except in compliance with the License. You may obtain a copy of
 6 * 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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations under
14 * the License.
15 */
16
17package com.google.android.marvin.talkback.speechrules;
18
19import android.content.Context;
20import android.view.accessibility.AccessibilityEvent;
21import android.view.accessibility.AccessibilityNodeInfo;
22
23interface NodeSpeechRule {
24    /**
25     * Determines whether this rule should process the specified node.
26     * @param node The node to filter.
27     * 
28     * @return {@code true} if this rule should process the node.
29     */
30    public boolean accept(AccessibilityNodeInfo node);
31
32    /**
33     * Processes the specified node and returns text to speak, or {@code null}
34     * if the node should not be spoken.
35     * 
36     * @param context The parent context.
37     * @param node The node to process.
38     * @param event The source event, may be {@code null} when called with
39     *            non-source nodes.
40     * @return A spoken description, or {@code null} if the node should not be
41     *         spoken.
42     */
43    public CharSequence
44            format(Context context, AccessibilityNodeInfo node, AccessibilityEvent event);
45}