public
abstract
class
ViewStructure
extends Object
java.lang.Object | |
↳ | android.view.ViewStructure |
Container for storing additional per-view data generated by View.onProvideStructure
.
Public constructors | |
---|---|
ViewStructure()
|
Public methods | |
---|---|
abstract
int
|
addChildCount(int num)
Add to this view's child count. |
abstract
void
|
asyncCommit()
Call when done populating a |
abstract
ViewStructure
|
asyncNewChild(int index)
Like |
abstract
int
|
getChildCount()
Return the child count as set by |
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 |
abstract
CharSequence
|
getText()
Retrieve the last |
abstract
int
|
getTextSelectionEnd()
Retrieve the last selection end set by |
abstract
int
|
getTextSelectionStart()
Retrieve the last selection start set by |
abstract
boolean
|
hasExtras()
Returns true if |
abstract
ViewStructure
|
newChild(int index)
Create a new child |
abstract
void
|
setAccessibilityFocused(boolean state)
Set the accessibility focused state of this view, as per
|
abstract
void
|
setActivated(boolean state)
Set the activated state of this view, as per |
abstract
void
|
setAlpha(float alpha)
Set an alpha transformation that is applied to this view, as per
|
abstract
void
|
setCheckable(boolean state)
Set the checkable state of this view, such as whether it implements the
|
abstract
void
|
setChecked(boolean state)
Set the checked state of this view, such as
|
abstract
void
|
setChildCount(int num)
Set the number of children of this view, which defines the range of indices you can
use with |
abstract
void
|
setClassName(String className)
Set the class name of the view, as per
|
abstract
void
|
setClickable(boolean state)
Set the clickable state of this view, as per |
abstract
void
|
setContentDescription(CharSequence contentDescription)
Set the content description of the view, as per
|
abstract
void
|
setContextClickable(boolean state)
Set the context clickable state of this view, as per
|
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
|
abstract
void
|
setEnabled(boolean state)
Set the enabled state of this view, as per |
abstract
void
|
setFocusable(boolean state)
Set the focusable state of this view, as per |
abstract
void
|
setFocused(boolean state)
Set the focused state of this view, as per |
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
|
abstract
void
|
setSelected(boolean state)
Set the selected state of this view, as per |
abstract
void
|
setText(CharSequence text)
Set the text that is associated with this view. |
abstract
void
|
setText(CharSequence text, int selectionStart, int selectionEnd)
Like |
abstract
void
|
setTextLines(int[] charOffsets, int[] baselines)
Set line information for test that was previously supplied through
|
abstract
void
|
setTextStyle(float size, int fgColor, int bgColor, int style)
Explicitly set default global style information for text that was previously set with
|
abstract
void
|
setTransformation(Matrix matrix)
Set the transformation matrix associated with this view, as per
|
abstract
void
|
setVisibility(int visibility)
Set the visibility state of this view, as per
|
Inherited methods | |
---|---|
From
class
java.lang.Object
|
int addChildCount (int num)
Add to this view's child count. This increases the current child count by
num children beyond what was last set by setChildCount(int)
or addChildCount(int)
. The index at which the new child starts in the child
array is returned.
Parameters | |
---|---|
num |
int :
The number of new children to add. |
Returns | |
---|---|
int |
Returns the index in the child array at which the new children start. |
void asyncCommit ()
Call when done populating a ViewStructure
returned by
asyncNewChild(int)
.
ViewStructure asyncNewChild (int index)
Like 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.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
ViewStructure |
Returns an fresh ViewStructure ready to be filled in.
|
int getChildCount ()
Return the child count as set by setChildCount(int)
.
Returns | |
---|---|
int |
Bundle getExtras ()
Get extra data associated with this view structure; the returned Bundle is mutable, allowing you to view and modify its contents. Keys placed in the Bundle should use an appropriate namespace prefix (such as com.google.MY_KEY) to avoid conflicts.
Returns | |
---|---|
Bundle |
CharSequence getHint ()
Retrieve the last hint set by setHint(CharSequence)
.
Returns | |
---|---|
CharSequence |
CharSequence getText ()
Retrieve the last setText(CharSequence)
.
Returns | |
---|---|
CharSequence |
int getTextSelectionEnd ()
Retrieve the last selection end set by setText(CharSequence, int, int)
.
Returns | |
---|---|
int |
int getTextSelectionStart ()
Retrieve the last selection start set by setText(CharSequence, int, int)
.
Returns | |
---|---|
int |
boolean hasExtras ()
Returns true if getExtras()
has been used to create extra content.
Returns | |
---|---|
boolean |
ViewStructure newChild (int index)
Create a new child ViewStructure
in this view, putting into the list of
children at index.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
ViewStructure |
Returns an fresh ViewStructure ready to be filled in.
|
void setAccessibilityFocused (boolean state)
Set the accessibility focused state of this view, as per
View.isAccessibilityFocused()
.
Parameters | |
---|---|
state |
boolean
|
void setActivated (boolean state)
Set the activated state of this view, as per View.isActivated()
.
Parameters | |
---|---|
state |
boolean
|
void setAlpha (float alpha)
Set an alpha transformation that is applied to this view, as per
View.getAlpha()
. Value ranges from 0
(completely transparent) to 1 (completely opaque); the default is 1, which means
no transformation.
Parameters | |
---|---|
alpha |
float
|
void setCheckable (boolean state)
Set the checkable state of this view, such as whether it implements the
Checkable
interface.
Parameters | |
---|---|
state |
boolean
|
void setChecked (boolean state)
Set the checked state of this view, such as
Checkable.isChecked()
.
Parameters | |
---|---|
state |
boolean
|
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)
. Calling this method again
resets all of the child state of the view, removing any children that had previously
been added.
Parameters | |
---|---|
num |
int
|
void setClassName (String className)
Set the class name of the view, as per
View.getAccessibilityClassName()
.
Parameters | |
---|---|
className |
String
|
void setClickable (boolean state)
Set the clickable state of this view, as per View.isClickable()
.
Parameters | |
---|---|
state |
boolean
|
void setContentDescription (CharSequence contentDescription)
Set the content description of the view, as per
View.getContentDescription()
.
Parameters | |
---|---|
contentDescription |
CharSequence
|
void setContextClickable (boolean state)
Set the context clickable state of this view, as per
View.isContextClickable()
.
Parameters | |
---|---|
state |
boolean
|
void setDimens (int left, int top, int scrollX, int scrollY, int width, int height)
Set the basic dimensions of this view.
Parameters | |
---|---|
left |
int :
The view's left position, in pixels relative to its parent's left edge. |
top |
int :
The view's top position, in pixels relative to its parent's top edge. |
scrollX |
int :
How much the view's x coordinate space has been scrolled, in pixels. |
scrollY |
int :
How much the view's y coordinate space has been scrolled, in pixels. |
width |
int :
The view's visible width, in pixels. This is the width visible on screen,
not the total data width of a scrollable view. |
height |
int :
The view's visible height, in pixels. This is the height visible on
screen, not the total data height of a scrollable view.
|
void setElevation (float elevation)
Set the visual elevation (shadow) of the view, as per
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.
Parameters | |
---|---|
elevation |
float
|
void setEnabled (boolean state)
Set the enabled state of this view, as per View.isEnabled()
.
Parameters | |
---|---|
state |
boolean
|
void setFocusable (boolean state)
Set the focusable state of this view, as per View.isFocusable()
.
Parameters | |
---|---|
state |
boolean
|
void setFocused (boolean state)
Set the focused state of this view, as per View.isFocused()
.
Parameters | |
---|---|
state |
boolean
|
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.
Parameters | |
---|---|
hint |
CharSequence
|
void setId (int id, String packageName, String typeName, String entryName)
Set the identifier for this view.
Parameters | |
---|---|
id |
int :
The view's identifier, as per View.getId() . |
packageName |
String :
The package name of the view's identifier, or null if there is none. |
typeName |
String :
The type name of the view's identifier, or null if there is none. |
entryName |
String :
The entry name of the view's identifier, or null if there is none.
|
void setLongClickable (boolean state)
Set the long clickable state of this view, as per
View.isLongClickable()
.
Parameters | |
---|---|
state |
boolean
|
void setSelected (boolean state)
Set the selected state of this view, as per View.isSelected()
.
Parameters | |
---|---|
state |
boolean
|
void setText (CharSequence text)
Set the text that is associated with this view. There is no selection associated with the text. The text may have style spans to supply additional display and semantic information.
Parameters | |
---|---|
text |
CharSequence
|
void setText (CharSequence text, int selectionStart, int selectionEnd)
Like setText(CharSequence)
but with an active selection
extending from selectionStart through selectionEnd.
Parameters | |
---|---|
text |
CharSequence
|
selectionStart |
int
|
selectionEnd |
int
|
void setTextLines (int[] charOffsets, int[] baselines)
Set line information for test that was previously supplied through
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.
Parameters | |
---|---|
charOffsets |
int :
The offset in to setText(CharSequence) where a line starts. |
baselines |
int :
The baseline where the line is drawn on screen.
|
void setTextStyle (float size, int fgColor, int bgColor, int style)
Explicitly set default global style information for text that was previously set with
setText(CharSequence)
.
Parameters | |
---|---|
size |
float :
The size, in pixels, of the text. |
fgColor |
int :
The foreground color, packed as 0xAARRGGBB. |
bgColor |
int :
The background color, packed as 0xAARRGGBB. |
style |
int :
Style flags, as defined by AssistStructure.ViewNode .
|
void setTransformation (Matrix matrix)
Set the transformation matrix associated with this view, as per
View.getMatrix()
, or null if there is none.
Parameters | |
---|---|
matrix |
Matrix
|
void setVisibility (int visibility)
Set the visibility state of this view, as per
View.getVisibility()
.
Parameters | |
---|---|
visibility |
int
|