blob: e4aa6b0d6cec1f9c26eecdfcedb5b42cb01f6b98 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.service.controls.templates;
import android.annotation.NonNull;
import android.os.Bundle;
import android.service.controls.Control;
import android.service.controls.actions.BooleanAction;
import com.android.internal.util.Preconditions;
/**
* A template for a {@link Control} with a single button that can be toggled between two states.
*
* The states for the toggle correspond to the states in {@link ControlButton#isChecked()}.
* An action on this template will originate a {@link BooleanAction} to change that state.
*
* @see BooleanAction
*/
public final class ToggleTemplate extends ControlTemplate {
private static final @TemplateType int TYPE = TYPE_TOGGLE;
private static final String KEY_BUTTON = "key_button";
private final @NonNull ControlButton mButton;
/**
* @param templateId the identifier for this template object
* @param button a {@link ControlButton} that can show the current state and toggle it
*/
public ToggleTemplate(@NonNull String templateId, @NonNull ControlButton button) {
super(templateId);
Preconditions.checkNotNull(button);
mButton = button;
}
/**
* @param b
* @hide
*/
ToggleTemplate(Bundle b) {
super(b);
mButton = b.getParcelable(KEY_BUTTON);
}
public boolean isChecked() {
return mButton.isChecked();
}
@NonNull
public CharSequence getContentDescription() {
return mButton.getActionDescription();
}
/**
* @return {@link ControlTemplate#TYPE_TOGGLE}
*/
@Override
public int getTemplateType() {
return TYPE;
}
/**
* @return
* @hide
*/
@Override
@NonNull
Bundle getDataBundle() {
Bundle b = super.getDataBundle();
b.putParcelable(KEY_BUTTON, mButton);
return b;
}
}
|
