VerticalGridPresenter

VerticalGridPresenter()

Constructs a VerticalGridPresenter with defaults. Uses ZOOM_FACTOR_LARGE for focus zooming and enabled dimming on focus.

VerticalGridPresenter(focusZoomFactor: Int)

Constructs a VerticalGridPresenter with the given parameters.

VerticalGridPresenter(focusZoomFactor: Int, useFocusDimmer: Boolean)

Constructs a VerticalGridPresenter with the given parameters.

fun areChildRoundedCornersEnabled(): Boolean

Returns true if rounded corners are enabled for children of this row.

fun enableChildRoundedCorners(enable: Boolean): Unit

Enables or disabled rounded corners on children of this row. Supported on Android SDK >= L.

fun getFocusZoomFactor(): Int

Returns the zoom factor used for focus highlighting.

fun getKeepChildForeground(): Boolean

Returns true if keeps foreground of child of this grid, the foreground will not be used for overlay color. Default value is true.

fun getNumberOfColumns(): Int

Returns the number of columns in the vertical grid.

fun getOnItemViewClickedListener(): OnItemViewClickedListener?

Returns the item clicked listener.

fun getOnItemViewSelectedListener(): OnItemViewSelectedListener?

Returns the item selected listener.

fun getShadowEnabled(): Boolean

Returns true if child shadow is enabled. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

fun isFocusDimmerUsed(): Boolean

Returns true if the focus dimmer is used for focus highlighting; false otherwise.

fun isUsingDefaultShadow(): Boolean

Default implementation returns true if SDK version >= 21, shadow (either static or z-order based) will be applied to each individual child of VerticalGridView. Subclass may return false to disable default implementation of shadow and provide its own.

fun isUsingZOrder(context: Context): Boolean

Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of vertical grid. If subclass returns false in isUsingDefaultShadow() and does not use Z-shadow on SDK >= L, it should override isUsingZOrder() return false.

fun onBindViewHolder(viewHolder: Presenter.ViewHolder, item: Any?): Unit

Binds a View to an item.

fun onCreateViewHolder(parent: ViewGroup): VerticalGridPresenter.ViewHolder

Creates a new View.

fun onUnbindViewHolder(viewHolder: Presenter.ViewHolder): Unit

Unbinds a View from an item. Any expensive references may be released here, and any fields that are not bound for every item should be cleared here.

fun setEntranceTransitionState(
    holder: VerticalGridPresenter.ViewHolder,
    afterEntrance: Boolean
): Unit

Changes the visibility of views. The entrance transition will be run against the views that change visibilities. This method is called by the fragment, it should not be called directly by the application.

fun setKeepChildForeground(keep: Boolean): Unit

Set if keeps foreground of child of this grid, the foreground will not be used for overlay color. Default value is true.

fun setNumberOfColumns(numColumns: Int): Unit

Sets the number of columns in the vertical grid.

fun setOnItemViewClickedListener(listener: OnItemViewClickedListener?): Unit

Sets the item clicked listener. OnItemViewClickedListener will override View.OnClickListener that item presenter sets during onCreateViewHolder. So in general, developer should choose one of the listeners but not both.

fun setOnItemViewSelectedListener(listener: OnItemViewSelectedListener?): Unit

Sets the item selected listener. Since this is a grid the row parameter is always null.

fun setShadowEnabled(enabled: Boolean): Unit

Enable or disable child shadow. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

protected fun createGridViewHolder(parent: ViewGroup): VerticalGridPresenter.ViewHolder

Subclass may override this to inflate a different layout.

protected fun createShadowOverlayOptions(): ShadowOverlayHelper.Options

Create ShadowOverlayHelper Options. Subclass may override. e.g. return new ShadowOverlayHelper.Options().roundedCornerRadius(10);

protected fun initializeGridViewHolder(vh: VerticalGridPresenter.ViewHolder): Unit

Called after a VerticalGridPresenter.ViewHolder is created. Subclasses may override this method and start by calling super.initializeGridViewHolder(ViewHolder).