/TalkBack/src/com/google/android/marvin/talkback/Formatter.java

 1/*
 2 * Copyright (C) 2009 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.google.android.marvin.talkback;
18
19import android.content.Context;
20import android.os.Bundle;
21import android.view.accessibility.AccessibilityEvent;
22
23/**
24 * This interface defines the contract for writing formatters. A formatter
25 * populates a formatted {@link Utterance} from an {@link AccessibilityEvent}.
26 * 
27 * @author svetoslavganov@google.com (Svetoslav Ganov)
28 */
29public interface Formatter {
30    /**
31     * Formats an <code>utterance</code> form given <code>event</code>.
32     * 
33     * @param event The event.
34     * @param context The context to be used for loading resources etc.
35     * @param utterance The utterance instance to populate.
36     * @param args Additional formatting arguments.
37     * @return {@code true} if the formatter produced output.
38     */
39    public boolean format(AccessibilityEvent event, Context context, Utterance utterance, Bundle args);
40}