Package icyllis.modernui.widget

Class ExpandableListView

java.lang.Object
icyllis.modernui.view.View
icyllis.modernui.view.ViewGroup
icyllis.modernui.widget.AdapterView<ListAdapter>
icyllis.modernui.widget.AbsListView
icyllis.modernui.widget.ListView
icyllis.modernui.widget.ExpandableListView
All Implemented Interfaces:
Drawable.Callback, ViewManager, ViewParent, Filter.FilterListener
public class ExpandableListView extends ListView
A view that shows items in a vertically scrolling two-level list. This differs from the ListView by allowing two levels: groups which can individually be expanded to show its children. The items come from the ExpandableListAdapter associated with this view.

Expandable lists are able to show an indicator beside each item to display the item's current state (the states are usually one of expanded group, collapsed group, child, or last child). Use setChildIndicator(Drawable) or setGroupIndicator(Drawable) (or the corresponding XML attributes) to set these indicators (see the docs for each method to see additional state that each Drawable can have). The default style for an ExpandableListView provides indicators which will be shown next to Views given to the ExpandableListView. The layouts android.R.layout.simple_expandable_list_item_1 and android.R.layout.simple_expandable_list_item_2 (which should be used with

invalid reference 
SimpleCursorTreeAdapter
) contain the preferred position information for indicators.

The context menu information set by an ExpandableListView will be a ExpandableListView.ExpandableListContextMenuInfo object with ExpandableListView.ExpandableListContextMenuInfo.packedPosition being a packed position that can be used with getPackedPositionType(long) and the other similar methods.

Note: You cannot use the value wrap_content for the android:layout_height attribute of a ExpandableListView in XML if the parent's size is also not strictly specified (for example, if the parent were ScrollView you could not specify wrap_content since it also can be any length. However, you can use wrap_content if the ExpandableListView parent has a specific size, such as 100 pixels.

  • Field Details

    • PACKED_POSITION_TYPE_GROUP

      public static final int PACKED_POSITION_TYPE_GROUP
      The packed position represents a group.
      See Also:

    • PACKED_POSITION_TYPE_CHILD

      public static final int PACKED_POSITION_TYPE_CHILD
      The packed position represents a child.
      See Also:

    • PACKED_POSITION_TYPE_NULL

      public static final int PACKED_POSITION_TYPE_NULL
      The packed position represents a neither/null/no preference.
      See Also:

    • PACKED_POSITION_VALUE_NULL

      public static final long PACKED_POSITION_VALUE_NULL
      The value for a packed position that represents neither/null/no preference. This value is not otherwise possible since a group type (first bit 0) should not have a child position filled.
      See Also:

    • CHILD_INDICATOR_INHERIT

      public static final int CHILD_INDICATOR_INHERIT
      Denotes when a child indicator should inherit this bound from the generic indicator bounds
      See Also:

  • Constructor Details

    • ExpandableListView

      public ExpandableListView(Context context)

  • Method Details

    • onRtlPropertiesChanged

      public void onRtlPropertiesChanged(int layoutDirection)
      Description copied from class: View
      Called when any RTL property (layout direction or text direction or text alignment) has been changed.

      Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction.

      The default implementation does nothing.

      Overrides:
      onRtlPropertiesChanged in class View
      Parameters:
      layoutDirection - the direction of the layout
      See Also:

    • dispatchDraw

      protected void dispatchDraw(@NonNull Canvas canvas)
      Description copied from class: View
      Draw the child views.
      Overrides:
      dispatchDraw in class ListView
      Parameters:
      canvas - the canvas to draw content

    • setChildDivider

      public void setChildDivider(Drawable childDivider)
      Sets the drawable that will be drawn adjacent to every child in the list. This will be drawn using the same height as the normal divider (ListView.setDivider(Drawable)) or if it does not have an intrinsic height, the height set by ListView.setDividerHeight(int).
      Parameters:
      childDivider - The drawable to use.

    • setAdapter

      public void setAdapter(ListAdapter adapter)
      This overloaded method should not be used, instead use setAdapter(ExpandableListAdapter).

      Sets the data behind this ListView.

      The adapter passed to this method may be wrapped by a WrapperListAdapter, depending on the ListView features currently in use. For instance, adding headers and/or footers will cause the adapter to be wrapped.

      Overrides:
      setAdapter in class ListView
      Parameters:
      adapter - The ListAdapter which is responsible for maintaining the data backing this list and for producing a view to represent an item in that data set.
      See Also:

    • getAdapter

      public ListAdapter getAdapter()
      This method should not be used, use getExpandableListAdapter().
      Overrides:
      getAdapter in class ListView
      Returns:
      The adapter currently used to display data in this ListView.
      See Also:

    • setOnItemClickListener

      public void setOnItemClickListener(AdapterView.OnItemClickListener l)
      Register a callback to be invoked when an item has been clicked and the caller prefers to receive a ListView-style position instead of a group and/or child position. In most cases, the caller should use setOnGroupClickListener(icyllis.modernui.widget.ExpandableListView.OnGroupClickListener) and/or setOnChildClickListener(icyllis.modernui.widget.ExpandableListView.OnChildClickListener).

      Register a callback to be invoked when an item in this AdapterView has been clicked.

      Overrides:
      setOnItemClickListener in class AdapterView<ListAdapter>
      Parameters:
      l - The callback that will be invoked.

    • setAdapter

      public void setAdapter(ExpandableListAdapter adapter)
      Sets the adapter that provides data to this view.
      Parameters:
      adapter - The adapter that provides data to this view.

    • getExpandableListAdapter

      public ExpandableListAdapter getExpandableListAdapter()
      Gets the adapter that provides data to this view.
      Returns:
      The adapter that provides data to this view.

    • performItemClick

      public boolean performItemClick(View v, int position, long id)
      Description copied from class: AdapterView
      Call the OnItemClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc.
      Overrides:
      performItemClick in class AbsListView
      Parameters:
      v - The view within the AdapterView that was clicked.
      position - The position of the view in the adapter.
      id - The row id of the item that was clicked.
      Returns:
      True if there was an assigned OnItemClickListener that was called, false otherwise is returned.

    • expandGroup

      public boolean expandGroup(int groupPos)
      Expand a group in the grouped list view
      Parameters:
      groupPos - the group to be expanded
      Returns:
      True if the group was expanded, false otherwise (if the group was already expanded, this will return false)

    • expandGroup

      public boolean expandGroup(int groupPos, boolean animate)
      Expand a group in the grouped list view
      Parameters:
      groupPos - the group to be expanded
      animate - true if the expanding group should be animated in
      Returns:
      True if the group was expanded, false otherwise (if the group was already expanded, this will return false)

    • collapseGroup

      public boolean collapseGroup(int groupPos)
      Collapse a group in the grouped list view
      Parameters:
      groupPos - position of the group to collapse
      Returns:
      True if the group was collapsed, false otherwise (if the group was already collapsed, this will return false)

    • setOnGroupCollapseListener

      public void setOnGroupCollapseListener(ExpandableListView.OnGroupCollapseListener onGroupCollapseListener)

    • setOnGroupExpandListener

      public void setOnGroupExpandListener(ExpandableListView.OnGroupExpandListener onGroupExpandListener)

    • setOnGroupClickListener

      public void setOnGroupClickListener(ExpandableListView.OnGroupClickListener onGroupClickListener)

    • setOnChildClickListener

      public void setOnChildClickListener(ExpandableListView.OnChildClickListener onChildClickListener)

    • getExpandableListPosition

      public long getExpandableListPosition(int flatListPosition)
      Converts a flat list position (the raw position of an item (child or group) in the list) to a group and/or child position (represented in a packed position). This is useful in situations where the caller needs to use the underlying ListView's methods. Use getPackedPositionType(long) , getPackedPositionChild(long), getPackedPositionGroup(long) to unpack.
      Parameters:
      flatListPosition - The flat list position to be converted.
      Returns:
      The group and/or child position for the given flat list position in packed position representation. #PACKED_POSITION_VALUE_NULL if the position corresponds to a header or a footer item.

    • getFlatListPosition

      public int getFlatListPosition(long packedPosition)
      Converts a group and/or child position to a flat list position. This is useful in situations where the caller needs to use the underlying ListView's methods.
      Parameters:
      packedPosition - The group and/or child positions to be converted in packed position representation. Use getPackedPositionForChild(int, int) or getPackedPositionForGroup(int).
      Returns:
      The flat list position for the given child or group.

    • getSelectedPosition

      public long getSelectedPosition()
      Gets the position of the currently selected group or child (along with its type). Can return PACKED_POSITION_VALUE_NULL if no selection.
      Returns:
      A packed position containing the currently selected group or child's position and type. #PACKED_POSITION_VALUE_NULL if no selection or if selection is on a header or a footer item.

    • getSelectedId

      public long getSelectedId()
      Gets the ID of the currently selected group or child. Can return -1 if no selection.
      Returns:
      The ID of the currently selected group or child. -1 if no selection.

    • setSelectedGroup

      public void setSelectedGroup(int groupPosition)
      Sets the selection to the specified group.
      Parameters:
      groupPosition - The position of the group that should be selected.

    • setSelectedChild

      public boolean setSelectedChild(int groupPosition, int childPosition, boolean shouldExpandGroup)
      Sets the selection to the specified child. If the child is in a collapsed group, the group will only be expanded and child subsequently selected if shouldExpandGroup is set to true, otherwise the method will return false.
      Parameters:
      groupPosition - The position of the group that contains the child.
      childPosition - The position of the child within the group.
      shouldExpandGroup - Whether the child's group should be expanded if it is collapsed.
      Returns:
      Whether the selection was successfully set on the child.

    • isGroupExpanded

      public boolean isGroupExpanded(int groupPosition)
      Whether the given group is currently expanded.
      Parameters:
      groupPosition - The group to check.
      Returns:
      Whether the group is currently expanded.

    • getPackedPositionType

      public static int getPackedPositionType(long packedPosition)
      Gets the type of a packed position. See getPackedPositionForChild(int, int).
      Parameters:
      packedPosition - The packed position for which to return the type.
      Returns:
      The type of the position contained within the packed position, either PACKED_POSITION_TYPE_CHILD, PACKED_POSITION_TYPE_GROUP, or PACKED_POSITION_TYPE_NULL.

    • getPackedPositionGroup

      public static int getPackedPositionGroup(long packedPosition)
      Gets the group position from a packed position. See getPackedPositionForChild(int, int).
      Parameters:
      packedPosition - The packed position from which the group position will be returned.
      Returns:
      The group position portion of the packed position. If this does not contain a group, returns -1.

    • getPackedPositionChild

      public static int getPackedPositionChild(long packedPosition)
      Gets the child position from a packed position that is of PACKED_POSITION_TYPE_CHILD type (use getPackedPositionType(long)). To get the group that this child belongs to, use getPackedPositionGroup(long). See getPackedPositionForChild(int, int).
      Parameters:
      packedPosition - The packed position from which the child position will be returned.
      Returns:
      The child position portion of the packed position. If this does not contain a child, returns -1.

    • getPackedPositionForChild

      public static long getPackedPositionForChild(int groupPosition, int childPosition)
      Returns the packed position representation of a child's position.

      In general, a packed position should be used in situations where the position given to/returned from an ExpandableListAdapter or ExpandableListView method can either be a child or group. The two positions are packed into a single long which can be unpacked using getPackedPositionChild(long), getPackedPositionGroup(long), and getPackedPositionType(long).

      Parameters:
      groupPosition - The child's parent group's position.
      childPosition - The child position within the group.
      Returns:
      The packed position representation of the child (and parent group).

    • getPackedPositionForGroup

      public static long getPackedPositionForGroup(int groupPosition)
      Returns the packed position representation of a group's position. See getPackedPositionForChild(int, int).
      Parameters:
      groupPosition - The child's parent group's position.
      Returns:
      The packed position representation of the group.

    • setChildIndicator

      public void setChildIndicator(Drawable childIndicator)
      Sets the indicator to be drawn next to a child.
      Parameters:
      childIndicator - The drawable to be used as an indicator. If the child is the last child for a group, the state R.attr.state_last will be set.

    • setChildIndicatorBounds

      public void setChildIndicatorBounds(int left, int right)
      Sets the drawing bounds for the child indicator. For either, you can specify CHILD_INDICATOR_INHERIT to use inherit from the general indicator's bounds.
      Parameters:
      left - The left position (relative to the left bounds of this View) to start drawing the indicator.
      right - The right position (relative to the left bounds of this View) to end the drawing of the indicator.
      See Also:

    • setChildIndicatorBoundsRelative

      public void setChildIndicatorBoundsRelative(int start, int end)
      Sets the relative drawing bounds for the child indicator. For either, you can specify CHILD_INDICATOR_INHERIT to use inherit from the general indicator's bounds.
      Parameters:
      start - The start position (relative to the start bounds of this View) to start drawing the indicator.
      end - The end position (relative to the end bounds of this View) to end the drawing of the indicator.
      See Also:

    • setGroupIndicator

      public void setGroupIndicator(Drawable groupIndicator)
      Sets the indicator to be drawn next to a group.
      Parameters:
      groupIndicator - The drawable to be used as an indicator. If the group is empty, the state R.attr.state_empty will be set. If the group is expanded, the state R.attr.state_expanded will be set.

    • setIndicatorBounds

      public void setIndicatorBounds(int left, int right)
      Sets the drawing bounds for the indicators (at minimum, the group indicator is affected by this; the child indicator is affected by this if the child indicator bounds are set to inherit).
      Parameters:
      left - The left position (relative to the left bounds of this View) to start drawing the indicator.
      right - The right position (relative to the left bounds of this View) to end the drawing of the indicator.
      See Also:

    • setIndicatorBoundsRelative

      public void setIndicatorBoundsRelative(int start, int end)
      Sets the relative drawing bounds for the indicators (at minimum, the group indicator is affected by this; the child indicator is affected by this if the child indicator bounds are set to inherit).
      Parameters:
      start - The start position (relative to the start bounds of this View) to start drawing the indicator.
      end - The end position (relative to the end bounds of this View) to end the drawing of the indicator.
      See Also: