net.sitecore.android.sdk.ui

Class ItemsBrowserFragment

java.lang.Object

android.app.Fragment

android.app.DialogFragment

net.sitecore.android.sdk.ui.ItemsBrowserFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnDismissListener, android.view.View.OnCreateContextMenuListener

Direct Known Subclasses:

ItemsGridBrowserFragment, ItemsListBrowserFragment

public abstract class ItemsBrowserFragment
extends android.app.DialogFragment

Abstract fragment that allows to browse through Sitecore content tree. It manages all network events and caches successful responses using ScItemsProvider content provider. Under the hood items are loaded using ScApiSession and cached in database using ScItemsProvider.

See Also:

ItemsListBrowserFragment, ItemsGridBrowserFragment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ItemsBrowserFragment.ContentTreePositionListener Defines content tree position change callback methods.
static interface	ItemsBrowserFragment.NetworkEventsListener Defines network events callback methods.

Nested classes/interfaces inherited from class android.app.Fragment

android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_GRID_COLUMNS_COUNT Default number of columns in grid mode.
static java.lang.String	DEFAULT_ROOT_FOLDER Default root items browser folder.

Fields inherited from class android.app.DialogFragment

STYLE_NO_FRAME, STYLE_NO_INPUT, STYLE_NO_TITLE, STYLE_NORMAL

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
ItemsBrowserFragment()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract android.widget.AbsListView	getContentView()
ScItem	getCurrentItem()
void	loadContent(ScApiSession session)
void	onActivityCreated(android.os.Bundle savedInstanceState)
void	onCreate(android.os.Bundle savedInstanceState)
protected android.view.View	onCreateEmptyView(android.view.LayoutInflater inflater)
protected android.view.View	onCreateFooterView(android.view.LayoutInflater inflater)
protected android.view.View	onCreateHeaderView(android.view.LayoutInflater inflater)
protected ItemViewBinder	onCreateItemViewBinder() Override this method to change the way content views are created from ScItem.
protected android.view.View	onCreateUpButtonView(android.view.LayoutInflater inflater) Creates view, intended for Up navigation through items tree.
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroyView()
void	onDetach()
void	onInflate(android.app.Activity activity, android.util.AttributeSet attrs, android.os.Bundle savedInstanceState)
void	onScItemClick(ScItem item)
void	onScItemLongClick(ScItem item)
void	onViewCreated(android.view.View view, android.os.Bundle savedInstanceState)
void	setContentTreePositionListener(ItemsBrowserFragment.ContentTreePositionListener contentTreePositionListener) Register a callback to be invoked when content state changes.
void	setEmptyText(int textResourceId)
void	setEmptyText(java.lang.String text)
void	setLoadContentWithoutConnection(boolean loadContentWithoutConnection)
void	setNetworkEventsListener(ItemsBrowserFragment.NetworkEventsListener networkEventsListener) Register a callback to be invoked when network operations state changes.
void	setRootFolder(java.lang.String rootFolder)
void	update() Trigger manual update of current folder.

Methods inherited from class android.app.DialogFragment

dismiss, dismissAllowingStateLoss, dump, getDialog, getShowsDialog, getTheme, isCancelable, onAttach, onCancel, onCreateDialog, onDismiss, onSaveInstanceState, onStart, onStop, setCancelable, setShowsDialog, setStyle, show, show

Methods inherited from class android.app.Fragment

equals, getActivity, getArguments, getChildFragmentManager, getFragmentManager, getId, getLoaderManager, getParentFragment, getResources, getRetainInstance, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isVisible, onActivityResult, onConfigurationChanged, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onResume, onTrimMemory, onViewStateRestored, registerForContextMenu, setArguments, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setRetainInstance, setTargetFragment, setUserVisibleHint, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ROOT_FOLDER

public static final java.lang.String DEFAULT_ROOT_FOLDER

Default root items browser folder.

See Also:

setRootFolder(String), Constant Field Values

DEFAULT_GRID_COLUMNS_COUNT

public static final int DEFAULT_GRID_COLUMNS_COUNT

Default number of columns in grid mode.

See Also:

Constant Field Values

Constructor Detail

ItemsBrowserFragment

public ItemsBrowserFragment()

Method Detail

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class android.app.DialogFragment

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                             android.view.ViewGroup container,
                             android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class android.app.Fragment

onActivityCreated

public void onActivityCreated(android.os.Bundle savedInstanceState)

Overrides:

onActivityCreated in class android.app.DialogFragment

getContentView

protected abstract android.widget.AbsListView getContentView()

onViewCreated

public void onViewCreated(android.view.View view,
                 android.os.Bundle savedInstanceState)

Overrides:

onViewCreated in class android.app.Fragment

onCreateHeaderView

protected android.view.View onCreateHeaderView(android.view.LayoutInflater inflater)

Parameters:

inflater - LayoutInflater object that can be used to inflate any views.

Returns:

Created header view. null is returned by default.

onCreateFooterView

protected android.view.View onCreateFooterView(android.view.LayoutInflater inflater)

Parameters:

inflater - LayoutInflater object that can be used to inflate any views.

Returns:

Created footer view. null is returned by default.

onCreateUpButtonView

protected android.view.View onCreateUpButtonView(android.view.LayoutInflater inflater)

Creates view, intended for Up navigation through items tree. This view will be added above items browser list. After creation View.OnClickListener will be set to created view, which triggers navigation up.

Parameters:

inflater - LayoutInflater object that can be used to inflate any views.

Returns:

View, intended for Up navigation through items tree.

onCreateEmptyView

protected android.view.View onCreateEmptyView(android.view.LayoutInflater inflater)

Parameters:

inflater - LayoutInflater object that can be used to inflate any views.

Returns:

Created view.

onCreateItemViewBinder

protected ItemViewBinder onCreateItemViewBinder()

Override this method to change the way content views are created from ScItem.

Returns:

ItemViewBinder

See Also:

ScItemsAdapter

onInflate

public void onInflate(android.app.Activity activity,
             android.util.AttributeSet attrs,
             android.os.Bundle savedInstanceState)

Overrides:

onInflate in class android.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class android.app.DialogFragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class android.app.DialogFragment

loadContent

public void loadContent(ScApiSession session)

Parameters:

session - ScApiSession to create the requests.

setLoadContentWithoutConnection

public void setLoadContentWithoutConnection(boolean loadContentWithoutConnection)

Parameters:

loadContentWithoutConnection - Use true to show cached content without setting ScApiSession.

setRootFolder

public void setRootFolder(java.lang.String rootFolder)

Parameters:

rootFolder - Top-level content tree folder. Fragment will be initialized using it as current folder.

update

public void update()

Trigger manual update of current folder.

setEmptyText

public void setEmptyText(java.lang.String text)

Parameters:

text - Text to set.

setEmptyText

public void setEmptyText(int textResourceId)

Parameters:

textResourceId - String resource id.

getCurrentItem

public ScItem getCurrentItem()

Returns:

Current item or null if data wasn't loaded.

onScItemClick

public void onScItemClick(ScItem item)

Parameters:

item - which received click event.

onScItemLongClick

public void onScItemLongClick(ScItem item)

Parameters:

item - which received long click.

setContentTreePositionListener

public void setContentTreePositionListener(ItemsBrowserFragment.ContentTreePositionListener contentTreePositionListener)

Register a callback to be invoked when content state changes.

Parameters:

contentTreePositionListener - the callback to be invoked.

setNetworkEventsListener

public void setNetworkEventsListener(ItemsBrowserFragment.NetworkEventsListener networkEventsListener)

Register a callback to be invoked when network operations state changes.

Parameters:

networkEventsListener - the callback to be invoked.