public abstract class ViewStructure extends Object
View.onProvideStructure
.Constructor and Description |
---|
ViewStructure() |
Modifier and Type | Method and Description |
---|---|
abstract int |
addChildCount(int num)
Add to this view's child count.
|
abstract void |
asyncCommit()
Call when done populating a
ViewStructure returned by
asyncNewChild(int) . |
abstract ViewStructure |
asyncNewChild(int index)
Like
newChild(int) , but allows the caller to asynchronously populate the returned
child. |
abstract int |
getChildCount()
Return the child count as set by
setChildCount(int) . |
abstract Bundle |
getExtras()
Get extra data associated with this view structure; the returned Bundle is mutable,
allowing you to view and modify its contents.
|
abstract CharSequence |
getHint()
Retrieve the last hint set by
setHint(java.lang.CharSequence) . |
abstract Rect |
getTempRect() |
abstract CharSequence |
getText()
Retrieve the last
setText(CharSequence) . |
abstract int |
getTextSelectionEnd()
Retrieve the last selection end set by
setText(CharSequence, int, int) . |
abstract int |
getTextSelectionStart()
Retrieve the last selection start set by
setText(CharSequence, int, int) . |
abstract boolean |
hasExtras()
Returns true if
getExtras() has been used to create extra content. |
abstract ViewStructure |
newChild(int index)
Create a new child
ViewStructure in this view, putting into the list of
children at index. |
abstract void |
setAccessibilityFocused(boolean state)
Set the accessibility focused state of this view, as per
View.isAccessibilityFocused() . |
abstract void |
setActivated(boolean state)
Set the activated state of this view, as per
View.isActivated() . |
abstract void |
setAlpha(float alpha)
Set an alpha transformation that is applied to this view, as per
View.getAlpha() . |
abstract void |
setAssistBlocked(boolean state) |
abstract void |
setCheckable(boolean state)
Set the checkable state of this view, such as whether it implements the
Checkable interface. |
abstract void |
setChecked(boolean state)
Set the checked state of this view, such as
Checkable.isChecked() . |
abstract void |
setChildCount(int num)
Set the number of children of this view, which defines the range of indices you can
use with
newChild(int) and asyncNewChild(int) . |
abstract void |
setClassName(String className)
Set the class name of the view, as per
View.getAccessibilityClassName() . |
abstract void |
setClickable(boolean state)
Set the clickable state of this view, as per
View.isClickable() . |
abstract void |
setContentDescription(CharSequence contentDescription)
Set the content description of the view, as per
View.getContentDescription() . |
abstract void |
setContextClickable(boolean state)
Set the context clickable state of this view, as per
View.isContextClickable() . |
abstract void |
setDimens(int left,
int top,
int scrollX,
int scrollY,
int width,
int height)
Set the basic dimensions of this view.
|
abstract void |
setElevation(float elevation)
Set the visual elevation (shadow) of the view, as per
View.getZ() . |
abstract void |
setEnabled(boolean state)
Set the enabled state of this view, as per
View.isEnabled() . |
abstract void |
setFocusable(boolean state)
Set the focusable state of this view, as per
View.isFocusable() . |
abstract void |
setFocused(boolean state)
Set the focused state of this view, as per
View.isFocused() . |
abstract void |
setHint(CharSequence hint)
Set optional hint text associated with this view; this is for example the text that is
shown by an EditText when it is empty to indicate to the user the kind of text to input.
|
abstract void |
setId(int id,
String packageName,
String typeName,
String entryName)
Set the identifier for this view.
|
abstract void |
setLongClickable(boolean state)
Set the long clickable state of this view, as per
View.isLongClickable() . |
abstract void |
setSelected(boolean state)
Set the selected state of this view, as per
View.isSelected() . |
abstract void |
setText(CharSequence text)
Set the text that is associated with this view.
|
abstract void |
setText(CharSequence text,
int selectionStart,
int selectionEnd)
Like
setText(CharSequence) but with an active selection
extending from selectionStart through selectionEnd. |
abstract void |
setTextLines(int[] charOffsets,
int[] baselines)
Set line information for test that was previously supplied through
setText(CharSequence) . |
abstract void |
setTextStyle(float size,
int fgColor,
int bgColor,
int style)
Explicitly set default global style information for text that was previously set with
setText(java.lang.CharSequence) . |
abstract void |
setTransformation(Matrix matrix)
Set the transformation matrix associated with this view, as per
View.getMatrix() , or null if there is none. |
abstract void |
setVisibility(int visibility)
Set the visibility state of this view, as per
View.getVisibility() . |
public abstract void setId(int id, String packageName, String typeName, String entryName)
id
- The view's identifier, as per View.getId()
.packageName
- The package name of the view's identifier, or null if there is none.typeName
- The type name of the view's identifier, or null if there is none.entryName
- The entry name of the view's identifier, or null if there is none.public abstract void setDimens(int left, int top, int scrollX, int scrollY, int width, int height)
left
- The view's left position, in pixels relative to its parent's left edge.top
- The view's top position, in pixels relative to its parent's top edge.scrollX
- How much the view's x coordinate space has been scrolled, in pixels.scrollY
- How much the view's y coordinate space has been scrolled, in pixels.width
- The view's visible width, in pixels. This is the width visible on screen,
not the total data width of a scrollable view.height
- The view's visible height, in pixels. This is the height visible on
screen, not the total data height of a scrollable view.public abstract void setTransformation(Matrix matrix)
View.getMatrix()
, or null if there is none.public abstract void setElevation(float elevation)
View.getZ()
. Note this is not related
to the physical Z-ordering of this view relative to its other siblings (that is how
they overlap when drawing), it is only the visual representation for shadowing.public abstract void setAlpha(float alpha)
View.getAlpha()
. Value ranges from 0
(completely transparent) to 1 (completely opaque); the default is 1, which means
no transformation.public abstract void setVisibility(int visibility)
View.getVisibility()
.public abstract void setAssistBlocked(boolean state)
public abstract void setEnabled(boolean state)
View.isEnabled()
.public abstract void setClickable(boolean state)
View.isClickable()
.public abstract void setLongClickable(boolean state)
View.isLongClickable()
.public abstract void setContextClickable(boolean state)
View.isContextClickable()
.public abstract void setFocusable(boolean state)
View.isFocusable()
.public abstract void setFocused(boolean state)
View.isFocused()
.public abstract void setAccessibilityFocused(boolean state)
View.isAccessibilityFocused()
.public abstract void setCheckable(boolean state)
Checkable
interface.public abstract void setChecked(boolean state)
Checkable.isChecked()
.public abstract void setSelected(boolean state)
View.isSelected()
.public abstract void setActivated(boolean state)
View.isActivated()
.public abstract void setClassName(String className)
View.getAccessibilityClassName()
.public abstract void setContentDescription(CharSequence contentDescription)
View.getContentDescription()
.public abstract void setText(CharSequence text)
public abstract void setText(CharSequence text, int selectionStart, int selectionEnd)
setText(CharSequence)
but with an active selection
extending from selectionStart through selectionEnd.public abstract void setTextStyle(float size, int fgColor, int bgColor, int style)
setText(java.lang.CharSequence)
.size
- The size, in pixels, of the text.fgColor
- The foreground color, packed as 0xAARRGGBB.bgColor
- The background color, packed as 0xAARRGGBB.style
- Style flags, as defined by AssistStructure.ViewNode
.public abstract void setTextLines(int[] charOffsets, int[] baselines)
setText(CharSequence)
. This provides the line breaking of the text as it
is shown on screen. This function takes ownership of the provided arrays; you should
not make further modification to them.charOffsets
- The offset in to setText(java.lang.CharSequence)
where a line starts.baselines
- The baseline where the line is drawn on screen.public abstract void setHint(CharSequence hint)
public abstract CharSequence getText()
setText(CharSequence)
.public abstract int getTextSelectionStart()
setText(CharSequence, int, int)
.public abstract int getTextSelectionEnd()
setText(CharSequence, int, int)
.public abstract CharSequence getHint()
setHint(java.lang.CharSequence)
.public abstract Bundle getExtras()
public abstract boolean hasExtras()
getExtras()
has been used to create extra content.public abstract void setChildCount(int num)
newChild(int)
and asyncNewChild(int)
. Calling this method again
resets all of the child state of the view, removing any children that had previously
been added.public abstract int addChildCount(int num)
setChildCount(int)
or addChildCount(int)
. The index at which the new child starts in the child
array is returned.num
- The number of new children to add.public abstract int getChildCount()
setChildCount(int)
.public abstract ViewStructure newChild(int index)
ViewStructure
in this view, putting into the list of
children at index.ViewStructure
ready to be filled in.public abstract ViewStructure asyncNewChild(int index)
newChild(int)
, but allows the caller to asynchronously populate the returned
child. It can transfer the returned ViewStructure
to another thread for it
to build its content (and children etc). Once done, some thread must call
asyncCommit()
to tell the containing ViewStructure
that the async
population is done.ViewStructure
ready to be filled in.public abstract void asyncCommit()
ViewStructure
returned by
asyncNewChild(int)
.public abstract Rect getTempRect()