Update more leanback javadocs.
Bug: 15149629
Change-Id: Ie98f9ab4a6ab555e06626e692fc2a75d207840e9
diff --git a/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRow.java b/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRow.java
index e5dbfaf..691f9c8 100644
--- a/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRow.java
+++ b/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRow.java
@@ -23,8 +23,8 @@
import java.util.List;
/**
- * The overview row for a details fragment. This row consists of an image, a
- * description view, and optionally a series of actions that can be taken for
+ * An overview row for a details fragment. This row consists of an image, a
+ * description view, and optionally a series of {@link Action}s that can be taken for
* the item.
*/
public class DetailsOverviewRow extends Row {
@@ -34,7 +34,7 @@
private ArrayList<Action> mActions = new ArrayList<Action>();
/**
- * Constructor.
+ * Constructor for a DetailsOverviewRow.
*
* @param item The main item for the details page.
*/
@@ -81,38 +81,38 @@
}
/**
- * Add an action to the overview.
+ * Add an Action to the overview.
*
- * @param action The action to add.
+ * @param action The Action to add.
*/
public final void addAction(Action action) {
mActions.add(action);
}
/**
- * Add an action to the overview at the specified position.
+ * Add an Action to the overview at the specified position.
*
- * @param pos The position to insert the action.
- * @param action The action to add.
+ * @param pos The position to insert the Action.
+ * @param action The Action to add.
*/
public final void addAction(int pos, Action action) {
mActions.add(pos, action);
}
/**
- * Remove the given action from the overview.
+ * Remove the given Action from the overview.
*
- * @param action The action to remove.
- * @return true if the overview contained the specified action.
+ * @param action The Action to remove.
+ * @return true if the overview contained the specified Action.
*/
public final boolean removeAction(Action action) {
return mActions.remove(action);
}
/**
- * Gets a read-only view of the list of actions of this details overview.
+ * Gets a read-only view of the list of Actions of this details overview.
*
- * @return An unmodifiable view of the list of actions.
+ * @return An unmodifiable view of the list of Actions.
*/
public final List<Action> getActions() {
return Collections.unmodifiableList(mActions);
diff --git a/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRowPresenter.java b/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRowPresenter.java
index 5509075..440337a 100644
--- a/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRowPresenter.java
+++ b/v17/leanback/src/android/support/v17/leanback/widget/DetailsOverviewRowPresenter.java
@@ -28,9 +28,9 @@
import java.util.Collection;
/**
- * DetailsOverviewRowPresenter renders {@link DetailsOverviewRow} to display an
+ * A DetailsOverviewRowPresenter renders a {@link DetailsOverviewRow} to display an
* overview of an item. Typically this row will be the first row in a fragment
- * such as {@link android.support.v17.leanback.app.DetailsFragment
+ * such as the {@link android.support.v17.leanback.app.DetailsFragment
* DetailsFragment}.
*
* <p>The detailed description is rendered using a {@link Presenter}.
@@ -42,6 +42,9 @@
private static final int MORE_ACTIONS_FADE_MS = 100;
+ /**
+ * A ViewHolder for the DetailsOverviewRow.
+ */
public static class ViewHolder extends RowPresenter.ViewHolder {
final ImageView mImageView;
final FrameLayout mDetailsDescriptionFrame;
@@ -120,6 +123,12 @@
}
}
+ /**
+ * Constructor for the ViewHolder.
+ *
+ * @param rootView The root View that this view holder will be attached
+ * to.
+ */
public ViewHolder(View rootView) {
super(rootView);
mImageView = (ImageView) rootView.findViewById(R.id.details_overview_image);
@@ -144,8 +153,10 @@
private boolean mIsStyleLarge = true;
/**
- * Constructor that uses the given {@link Presenter} to render the detailed
- * description for the row.
+ * Constructor for a DetailsOverviewRowPresenter.
+ *
+ * @param detailsPresenter The {@link Presenter} used to render the detailed
+ * description of the row.
*/
public DetailsOverviewRowPresenter(Presenter detailsPresenter) {
setHeaderPresenter(null);
@@ -156,21 +167,21 @@
}
/**
- * Sets the listener for action click events.
+ * Sets the listener for Action click events.
*/
public void setOnActionClickedListener(OnActionClickedListener listener) {
mActionPresenterSelector.setOnActionClickedListener(listener);
}
/**
- * Gets the listener for action click events.
+ * Gets the listener for Action click events.
*/
public OnActionClickedListener getOnActionClickedListener() {
return mActionPresenterSelector.getOnActionClickedListener();
}
/**
- * Sets the background color. If not set a default from the theme will be used.
+ * Sets the background color. If not set, a default from the theme will be used.
*/
public void setBackgroundColor(int color) {
mBackgroundColor = color;
@@ -178,15 +189,16 @@
}
/**
- * Returns the background color. If no background color was set, returns transparent.
+ * Returns the background color. If no background color was set, transparent
+ * is returned.
*/
public int getBackgroundColor() {
return mBackgroundColor;
}
/**
- * Sets the layout style to be large or small.
- * The default is large.
+ * Sets the layout style to be large or small. This affects the height of
+ * the overview, including the text description. The default is large.
*/
public void setStyleLarge(boolean large) {
mIsStyleLarge = large;