Most visited

Recently visited

Results for

Summary: Nested Classes | Constants | Inherited Constants | Protected Ctors | Methods | Inherited Methods | [Expand All]

GuidedAction

public class GuidedAction
extends Action

java.lang.Object
   ↳ android.support.v17.leanback.widget.Action
     ↳ android.support.v17.leanback.widget.GuidedAction
Known Direct Subclasses

表示GuidedStepFragment内的动作的数据类。 GuidedActions包含至少一个标题和一个描述，通常也是一个图标。

GuidedAction通常表示用户可能采取的单个动作，但也可以表示一组互斥选项（类似于单选按钮）或仅信息标签（在这种情况下该项目不能被点击）中的可能选择， 。

GuidedActions可以选择性地被检查。 他们也可能会表示他们会在选择时要求更多的用户输入，在这种情况下，他们将显示一个V形指示符。

GuidedAction建议使用GuidedAction.Builder 。 当应用程序子类GuidedAction时，它可以GuidedAction.BuilderBase ，实现它自己的builder（）方法，它应该调用applyValues(GuidedAction) 。

Summary

Nested classes
class GuidedAction.Builder

构建一个GuidedAction对象。

class GuidedAction.BuilderBase<B extends BuilderBase>

基础构建器类构建一个GuidedAction对象。

Constants
long ACTION_ID_CANCEL

标准取消操作的标识。
long ACTION_ID_CONTINUE

标准完成操作的标识。
long ACTION_ID_CURRENT

完成编辑后，请继续进行当前操作。
long ACTION_ID_FINISH

标准完成操作的标识。
long ACTION_ID_NEXT

完成编辑后，转到下一个动作。
long ACTION_ID_NO

标准没有行动的标识。
long ACTION_ID_OK

标准OK行为的标识。
long ACTION_ID_YES

标准是行动的标识。
int CHECKBOX_CHECK_SET_ID

Checkset Id复选框。
int DEFAULT_CHECK_SET_ID

收音机的默认检查集ID。
int NO_CHECK_SET

特殊检查集ID既不是复选框也不是收音机。

Inherited constants
From class android.support.v17.leanback.widget.Action

Protected constructors
GuidedAction()

Public methods
int getCheckSetId()

返回此操作所属的检查集ID。
CharSequence getDescription()

返回此操作的描述。
int getDescriptionEditInputType()

返回编辑中动作描述的InputType; 仅在isDescriptionEditable()为真时有效。
int getDescriptionInputType()

返回操作说明的InputType不在编辑中。
CharSequence getEditDescription()

返回可选的描述文本进行编辑。
int getEditInputType()

返回编辑中动作标题的InputType; 只有当isEditable()为真时才有效。
CharSequence getEditTitle()

返回可选标题文本以进行编辑。
int getInputType()

返回操作标题的InputType不在编辑中。
Intent getIntent()

返回与此操作关联的意图。
List<GuidedAction> getSubActions()
CharSequence getTitle()

返回此操作的标题。
boolean hasEditableActivatorView()

返回是否可以激活此操作以进行编辑，例如
boolean hasMultilineDescription()

返回此操作是否具有多行描述。
boolean hasNext()

返回选择时此操作是否会请求进一步的用户输入，例如显示另一个GuidedStepFragment或启动新的活动。
boolean hasSubActions()
boolean hasTextEditable()

如果此操作具有可编辑标题或可编辑描述，则返回。
boolean infoOnly()

返回操作是否仅显示信息，因此无法点击。
final boolean isAutoSaveRestoreEnabled()

如果Action将保存到instanceState并稍后恢复，则返回true，否则返回false。
boolean isChecked()

返回是否选中此操作。
boolean isDescriptionEditable()

返回此操作描述是否可编辑。
boolean isEditTitleUsed()

如果 getEditTitle()不为null，则返回true。
boolean isEditable()

返回此操作标题是否可编辑。
boolean isEnabled()

返回是否启用此操作。
boolean isFocusable()

返回此操作是否可以调焦。
void onRestoreInstanceState(Bundle bundle, String key)

使用给定键从软件包中恢复操作。
void onSaveInstanceState(Bundle bundle, String key)

使用给定的键将操作保存到一个包中。
void setChecked(boolean checked)

设置是否检查此操作。
void setDescription(CharSequence description)

设置此操作的描述。
void setEditDescription(CharSequence editDescription)

将可选说明文字设置为编辑而不是 setDescription(CharSequence) 。
void setEditTitle(CharSequence editTitle)

将可选标题文本设置为编辑而不是 setTitle(CharSequence) 。
void setEnabled(boolean enabled)

设置是否启用此操作。
void setFocusable(boolean focusable)

设置此操作是否可以调整。
void setIntent(Intent intent)

设置此操作的意图。
void setSubActions(List<GuidedAction> actions)

更改子动作列表。
void setTitle(CharSequence title)

设置此操作的标题。

Inherited methods
From class android.support.v17.leanback.widget.Action
From class java.lang.Object

Constants

ACTION_ID_CANCEL

long ACTION_ID_CANCEL

标准取消操作的标识。

常量值：-5（0xfffffffffffffffb）

ACTION_ID_CONTINUE

long ACTION_ID_CONTINUE

标准完成操作的标识。

常量值：-7（0xfffffffffffffff9）

ACTION_ID_CURRENT

long ACTION_ID_CURRENT

完成编辑后，请继续进行当前操作。

常量值：-3（0xfffffffffffffffd）

ACTION_ID_FINISH

long ACTION_ID_FINISH

标准完成操作的标识。

常量值：-6（0xfffffffffffffffa）

ACTION_ID_NEXT

long ACTION_ID_NEXT

完成编辑后，转到下一个动作。

常量值：-2（0xfffffffffffffffe）

ACTION_ID_NO

long ACTION_ID_NO

标准没有行动的标识。

常量值：-9（0xfffffffffffffff7）

ACTION_ID_OK

long ACTION_ID_OK

标准OK行为的标识。

常量值：-4（0xfffffffffffffffc）

ACTION_ID_YES

long ACTION_ID_YES

标准是行动的标识。

常数值：-8（0xfffffffffffffff8）

CHECKBOX_CHECK_SET_ID

int CHECKBOX_CHECK_SET_ID

Checkset Id复选框。

常量值：-1（0xffffffff）

DEFAULT_CHECK_SET_ID

int DEFAULT_CHECK_SET_ID

收音机的默认检查集ID。

常数值：1（0x00000001）

NO_CHECK_SET

int NO_CHECK_SET

特殊检查集ID既不是复选框也不是收音机。

常量值：0（0x00000000）

Protected constructors

GuidedAction

GuidedAction ()

Public methods

getCheckSetId

int getCheckSetId ()

返回此操作所属的检查集ID。 具有相同检查集ID的同一列表中的所有操作都被视为链接。 当选择该组中的某个动作时，该动作将被检查，而所有其他动作均未被选中。

Returns
int an integer representing the check set this action is a part of, or CHECKBOX_CHECK_SET_ID if this is a checkbox, or NO_CHECK_SET if this action is not a checkbox or radiobutton.

getDescription

CharSequence getDescription ()

返回此操作的描述。

Returns
CharSequence The description of this action.

getDescriptionEditInputType

int getDescriptionEditInputType ()

返回编辑中动作描述的InputType; 只有当isDescriptionEditable()为真时才有效。

Returns
int InputType of action description in editing.

getDescriptionInputType

int getDescriptionInputType ()

返回操作说明的InputType不在编辑中。

Returns
int InputType of action description not in editing.

getEditDescription

CharSequence getEditDescription ()

返回可选的描述文本进行编辑。 当不为空时，它将被编辑而不是getDescription() 。

Returns
CharSequence Optional description text to edit instead of getDescription().

getEditInputType

int getEditInputType ()

返回编辑中动作标题的InputType; 只有当isEditable()为真时才有效。

Returns
int InputType of action title in editing.

getEditTitle

CharSequence getEditTitle ()

返回可选标题文本以进行编辑。 当不为空时，它将被编辑而不是getTitle() 。

Returns
CharSequence Optional title text to edit instead of getTitle().

getInputType

int getInputType ()

返回操作标题的InputType不在编辑中。

Returns
int InputType of action title not in editing.

getIntent

Intent getIntent ()

返回与此操作关联的意图。

Returns
Intent The intent set when this action was built.

getSubActions

List<GuidedAction> getSubActions ()

Returns
List<GuidedAction> List of sub actions or null if sub actions list is not enabled.

getTitle

CharSequence getTitle ()

返回此操作的标题。

Returns
CharSequence The title set when this action was built.

hasEditableActivatorView

boolean hasEditableActivatorView ()

返回是否可以激活此操作以进行编辑，例如DatePicker。

Returns
boolean true if the action can be activated to edit.

hasMultilineDescription

boolean hasMultilineDescription ()

返回此操作是否具有多行描述。

Returns
boolean true if the action was constructed as having a multiline description, false otherwise.

hasNext

boolean hasNext ()

返回选择时此操作是否会请求进一步的用户输入，例如显示另一个GuidedStepFragment或启动新的活动。 在施工期间进行配置。

Returns
boolean true if the action will request further user input when selected, false otherwise.

hasSubActions

boolean hasSubActions ()

Returns
boolean True if has sub actions list, even it's currently empty.

hasTextEditable

boolean hasTextEditable ()

如果此操作具有可编辑标题或可编辑描述，则返回。

Returns
boolean True if this action has editable title or editable description, false otherwise.

infoOnly

boolean infoOnly ()

返回操作是否仅显示信息，因此无法点击。 如果this和hasNext()都是true，则infoOnly优先。 默认值是false。 例如，这可能表示例如文档使用的存储量或应用程序的成本。

Returns
boolean true if will only display information, false otherwise.

isAutoSaveRestoreEnabled

boolean isAutoSaveRestoreEnabled ()

如果Action将保存到instanceState并稍后恢复，则返回true，否则返回false。 默认值是true。 当isAutoSaveRestoreEnabled（）为true并且getId()不是NO_ID ：

  • isEditable() is true: save text of getTitle()
  • isDescriptionEditable() is true: save text of getDescription()
  • getCheckSetId() is not NO_CHECK_SET: save isChecked()}
  • GuidedDatePickerAction will be saved
    • App may explicitly disable auto restore and handle by itself. App should override Fragment onSaveInstanceState() and onCreateActions()

    Returns
    boolean True if Action will be saved to instanceState and restored later, false otherwise.

    isChecked

    boolean isChecked ()

    返回是否选中此操作。

    Returns
    boolean true if the action is currently checked, false otherwise.

    isDescriptionEditable

    boolean isDescriptionEditable ()

    返回此操作描述是否可编辑。

    Returns
    boolean true if the action description is editable, false otherwise.

    isEditTitleUsed

    boolean isEditTitleUsed ()

    如果getEditTitle()不为null，则返回true。 如果为true，则getEditTitle()正在编辑的代替getTitle() 。

    Returns
    boolean true if getEditTitle() is not null.

    isEditable

    boolean isEditable ()

    返回此操作标题是否可编辑。

    Returns
    boolean true if the action title is editable, false otherwise.

    isEnabled

    boolean isEnabled ()

    返回是否启用此操作。

    Returns
    boolean true if the action is currently enabled, false otherwise.

    isFocusable

    boolean isFocusable ()

    返回此操作是否可以调焦。

    Returns
    boolean true if the action is currently focusable, false otherwise.

    onRestoreInstanceState

    void onRestoreInstanceState (Bundle bundle, 
                String key)

    Restore action from a bundle using a given key. When isAutoRestore() is true:

  • isEditable() is true: save text of getTitle()
  • isDescriptionEditable() is true: save text of getDescription()
  • getCheckSetId() is not NO_CHECK_SET: save isChecked()}
  • GuidedDatePickerAction will be saved
    • Subclass may override this method.

    Parameters
    bundle Bundle: Bundle to restore the Action from.
    key String: Key used to restore the Action.

    onSaveInstanceState

    void onSaveInstanceState (Bundle bundle, 
                String key)

    Save action into a bundle using a given key. When isAutoRestoreEna() is true:

  • isEditable() is true: save text of getTitle()
  • isDescriptionEditable() is true: save text of getDescription()
  • getCheckSetId() is not NO_CHECK_SET: save isChecked()}
  • GuidedDatePickerAction will be saved
    • Subclass may override this method.

    Parameters
    bundle Bundle: Bundle to save the Action.
    key String: Key used to save the Action.

    setChecked

    void setChecked (boolean checked)

    设置是否检查此操作。

    Parameters
    checked boolean: Whether this action should be checked.

    setDescription

    void setDescription (CharSequence description)

    设置此操作的描述。

    Parameters
    description CharSequence: The description of the action.

    setEditDescription

    void setEditDescription (CharSequence editDescription)

    设置可选的描述文本来编辑，而不是 setDescription(CharSequence) 。

    Parameters
    editDescription CharSequence: Optional description text to edit instead of setDescription(CharSequence).

    setEditTitle

    void setEditTitle (CharSequence editTitle)

    将可选标题文本设置为编辑而不是 setTitle(CharSequence) 。

    Parameters
    editTitle CharSequence: Optional title text to edit instead of setTitle(CharSequence).

    setEnabled

    void setEnabled (boolean enabled)

    设置是否启用此操作。

    Parameters
    enabled boolean: Whether this action should be enabled.

    setFocusable

    void setFocusable (boolean focusable)

    设置此操作是否可以调整。

    Parameters
    focusable boolean: Whether this action should be focusable.

    setIntent

    void setIntent (Intent intent)

    设置此操作的意图。

    Parameters
    intent Intent: New intent to set on this action.

    setSubActions

    void setSubActions (List<GuidedAction> actions)

    更改子动作列表。

    Parameters
    actions List: Sub actions list to set on this action. Sets null to disable sub actions.

    setTitle

    void setTitle (CharSequence title)

    设置此操作的标题。

    Parameters
    title CharSequence: The title set when this action was built.
    Android开发手册

    Hooray!