public class

NewPageDialog

extends AppCompatDialogFragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	androidx.fragment.app.DialogFragment
		↳	androidx.appcompat.app.AppCompatDialogFragment
			↳	com.pspdfkit.document.editor.page.NewPageDialog

Class Overview

Dialog for choosing properties for a newly created PDF page. A call to show(FragmentManager, Size, List, Callback) will prepare and show the dialog, creating it if necessary. When calling this method after a configuration change, it will restore and use the previously added dialog.

Summary

Nested Classes
interface	NewPageDialog.Callback	This listener interface needs to be implemented by any class that wishes to handle new page creation event.

Constants
String	ARG_DOCUMENT_PAGE_SIZE	Name of the fragment argument carrying the document page `Size`.
String	FRAGMENT_TAG	Fragment transaction tag used by this dialog.

[Expand]

Inherited Constants

From class androidx.fragment.app.DialogFragment

[Expand]

Inherited Fields

From class androidx.fragment.app.Fragment

Public Constructors
	NewPageDialog() Primary constructor of the `NewPageDialog`.

Public Methods
Context	getContext()
static void	hide(FragmentManager fragmentManager) Hides the dialog if visible.
void	onCreate(Bundle savedInstanceState)
Dialog	onCreateDialog(Bundle savedInstanceState)
void	onDismiss(DialogInterface dialog)
void	onStart()
static boolean	restore(FragmentManager fragmentManager, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback) Restore existing dialog.
static boolean	restore(FragmentManager fragmentManager, NewPageDialog.Callback callback) Restore existing dialog.
static boolean	restore(FragmentManager fragmentManager, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback) Restore existing dialog.
void	setupDialog(Dialog dialog, int style)
static void	show(FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback) Shows the dialog to the user.
static void	show(FragmentManager fragmentManager, Size documentPageSize, NewPageDialog.Callback callback) Shows the dialog to the user.
static void	show(FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback) Shows the dialog to the user.

Protected Methods
void	onAddButtonClicked() Called when the user presses the "Add" button of the dialog.

[Expand]

Inherited Methods

From class androidx.appcompat.app.AppCompatDialogFragment

From class androidx.fragment.app.DialogFragment

From class androidx.fragment.app.Fragment

void	dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)
final boolean	equals(Object arg0)
final FragmentActivity	getActivity()
boolean	getAllowEnterTransitionOverlap()
boolean	getAllowReturnTransitionOverlap()
final Bundle	getArguments()
final FragmentManager	getChildFragmentManager()
Context	getContext()
CreationExtras	getDefaultViewModelCreationExtras()
ViewModelProvider.Factory	getDefaultViewModelProviderFactory()
Object	getEnterTransition()
Object	getExitTransition()
final FragmentManager	getFragmentManager()
final Object	getHost()
final int	getId()
LayoutInflater	getLayoutInflater(Bundle arg0)
final LayoutInflater	getLayoutInflater()
Lifecycle	getLifecycle()
LoaderManager	getLoaderManager()
final Fragment	getParentFragment()
final FragmentManager	getParentFragmentManager()
Object	getReenterTransition()
final Resources	getResources()
final boolean	getRetainInstance()
Object	getReturnTransition()
final SavedStateRegistry	getSavedStateRegistry()
Object	getSharedElementEnterTransition()
Object	getSharedElementReturnTransition()
final String	getString(int arg0, Object... arg1)
final String	getString(int arg0)
final String	getTag()
final Fragment	getTargetFragment()
final int	getTargetRequestCode()
final CharSequence	getText(int arg0)
boolean	getUserVisibleHint()
View	getView()
LifecycleOwner	getViewLifecycleOwner()
LiveData<LifecycleOwner>	getViewLifecycleOwnerLiveData()
ViewModelStore	getViewModelStore()
final boolean	hasOptionsMenu()
final int	hashCode()
static Fragment	instantiate(Context arg0, String arg1)
static Fragment	instantiate(Context arg0, String arg1, Bundle arg2)
final boolean	isAdded()
final boolean	isDetached()
final boolean	isHidden()
final boolean	isInLayout()
final boolean	isMenuVisible()
final boolean	isRemoving()
final boolean	isResumed()
final boolean	isStateSaved()
final boolean	isVisible()
void	onActivityCreated(Bundle arg0)
void	onActivityResult(int arg0, int arg1, Intent arg2)
void	onAttach(Activity arg0)
void	onAttach(Context arg0)
void	onAttachFragment(Fragment arg0)
void	onConfigurationChanged(Configuration arg0)
boolean	onContextItemSelected(MenuItem arg0)
void	onCreate(Bundle arg0)
Animation	onCreateAnimation(int arg0, boolean arg1, int arg2)
Animator	onCreateAnimator(int arg0, boolean arg1, int arg2)
void	onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
void	onCreateOptionsMenu(Menu arg0, MenuInflater arg1)
View	onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)
void	onDestroy()
void	onDestroyOptionsMenu()
void	onDestroyView()
void	onDetach()
LayoutInflater	onGetLayoutInflater(Bundle arg0)
void	onHiddenChanged(boolean arg0)
void	onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)
void	onInflate(Context arg0, AttributeSet arg1, Bundle arg2)
void	onLowMemory()
void	onMultiWindowModeChanged(boolean arg0)
boolean	onOptionsItemSelected(MenuItem arg0)
void	onOptionsMenuClosed(Menu arg0)
void	onPause()
void	onPictureInPictureModeChanged(boolean arg0)
void	onPrepareOptionsMenu(Menu arg0)
void	onPrimaryNavigationFragmentChanged(boolean arg0)
void	onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)
void	onResume()
void	onSaveInstanceState(Bundle arg0)
void	onStart()
void	onStop()
void	onViewCreated(View arg0, Bundle arg1)
void	onViewStateRestored(Bundle arg0)
void	postponeEnterTransition()
final void	postponeEnterTransition(long arg0, TimeUnit arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultCallback<O> arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultRegistry arg1, ActivityResultCallback<O> arg2)
void	registerForContextMenu(View arg0)
final void	requestPermissions(String[] arg0, int arg1)
final FragmentActivity	requireActivity()
final Bundle	requireArguments()
final Context	requireContext()
final FragmentManager	requireFragmentManager()
final Object	requireHost()
final Fragment	requireParentFragment()
final View	requireView()
void	setAllowEnterTransitionOverlap(boolean arg0)
void	setAllowReturnTransitionOverlap(boolean arg0)
void	setArguments(Bundle arg0)
void	setEnterSharedElementCallback(SharedElementCallback arg0)
void	setEnterTransition(Object arg0)
void	setExitSharedElementCallback(SharedElementCallback arg0)
void	setExitTransition(Object arg0)
void	setHasOptionsMenu(boolean arg0)
void	setInitialSavedState(Fragment.SavedState arg0)
void	setMenuVisibility(boolean arg0)
void	setReenterTransition(Object arg0)
void	setRetainInstance(boolean arg0)
void	setReturnTransition(Object arg0)
void	setSharedElementEnterTransition(Object arg0)
void	setSharedElementReturnTransition(Object arg0)
void	setTargetFragment(Fragment arg0, int arg1)
void	setUserVisibleHint(boolean arg0)
boolean	shouldShowRequestPermissionRationale(String arg0)
void	startActivity(Intent arg0)
void	startActivity(Intent arg0, Bundle arg1)
void	startActivityForResult(Intent arg0, int arg1)
void	startActivityForResult(Intent arg0, int arg1, Bundle arg2)
void	startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)
void	startPostponedEnterTransition()
String	toString()
void	unregisterForContextMenu(View arg0)

From class java.lang.Object

From interface android.content.ComponentCallbacks

From interface android.content.DialogInterface.OnCancelListener

From interface android.content.DialogInterface.OnDismissListener

From interface android.view.View.OnCreateContextMenuListener

From interface androidx.activity.result.ActivityResultCaller

From interface androidx.lifecycle.HasDefaultViewModelProviderFactory

From interface androidx.lifecycle.LifecycleOwner

From interface androidx.lifecycle.ViewModelStoreOwner

From interface androidx.savedstate.SavedStateRegistryOwner

Constants

public static final String ARG_DOCUMENT_PAGE_SIZE

Name of the fragment argument carrying the document page Size. The argument use is optional.

public static final String FRAGMENT_TAG

Fragment transaction tag used by this dialog. When using show(FragmentManager, Size, List, Callback) the dialog will automatically use this tag.

Public Constructors

public NewPageDialog ()

Primary constructor of the NewPageDialog.

Public Methods

public Context getContext ()

public static void hide (FragmentManager fragmentManager)

Hides the dialog if visible.

Parameters

fragmentManager	Fragment manager for performing necessary fragment transactions.

public void onCreate (Bundle savedInstanceState)

public Dialog onCreateDialog (Bundle savedInstanceState)

public void onDismiss (DialogInterface dialog)

public void onStart ()

public static boolean restore (FragmentManager fragmentManager, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback)

Restore existing dialog.

Parameters

fragmentManager	Fragment manager for querying dialog fragment state.
pageTemplates	A list of `PageTemplate`s that the user can select from in addition to the original patterns.
showPageTemplatesLast	Set to `true` to display your `PageTemplate`s after page pattern options. Set to `false` by default.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

Returns

True when dialog has been restored, false otherwise.

public static boolean restore (FragmentManager fragmentManager, NewPageDialog.Callback callback)

Restore existing dialog.

Parameters

fragmentManager	Fragment manager for querying dialog fragment state.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

Returns

True when dialog has been restored, false otherwise.

public static boolean restore (FragmentManager fragmentManager, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback)

Restore existing dialog.

Parameters

fragmentManager	Fragment manager for querying dialog fragment state.
pageTemplates	A list of `PageTemplate`s that the user can select from in addition to the original patterns.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

Returns

True when dialog has been restored, false otherwise.

public void setupDialog (Dialog dialog, int style)

public static void show (FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback)

Shows the dialog to the user.

Parameters

fragmentManager	Fragment manager for performing necessary fragment transactions.
documentPageSize	A custom size representative for the current document. This size option will be called "document size" inside the page size dropdown list, and will be selected by default. The caller needs to define this size, or pass in `null` to deactivate that option.
pageTemplates	A list of `PageTemplate`s that the user can select from in addition to the default patterns.
showPageTemplatesLast	Set to `true` to display your `PageTemplate`s after page pattern options. Set to `false` by default.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

public static void show (FragmentManager fragmentManager, Size documentPageSize, NewPageDialog.Callback callback)

Shows the dialog to the user.

Parameters

fragmentManager	Fragment manager for performing necessary fragment transactions.
documentPageSize	A custom size representative for the current document. This size option will be called "document size" inside the page size dropdown list, and will be selected by default. The caller needs to define this size, or pass in `null` to deactivate that option.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

public static void show (FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback)

Shows the dialog to the user.

Parameters

fragmentManager	Fragment manager for performing necessary fragment transactions.
documentPageSize	A custom size representative for the current document. This size option will be called "document size" inside the page size dropdown list, and will be selected by default. The caller needs to define this size, or pass in `null` to deactivate that option.
pageTemplates	A list of `PageTemplate`s that the user can select from in addition to the default patterns.
callback	A `NewPageDialog.Callback` that will be notified of confirmation or dismissal of the dialog.

Protected Methods

protected void onAddButtonClicked ()

Called when the user presses the "Add" button of the dialog. The default implementation will dismiss the dialog and notify any NewPageDialog.Callback.

Interfaces

Classes

NewPageDialog

Class Overview

Summary

Constants

public static final String ARG_DOCUMENT_PAGE_SIZE

See Also

public static final String FRAGMENT_TAG

See Also

Public Constructors

public NewPageDialog ()

Public Methods

public Context getContext ()

public static void hide (FragmentManager fragmentManager)

Parameters

public void onCreate (Bundle savedInstanceState)

public Dialog onCreateDialog (Bundle savedInstanceState)

public void onDismiss (DialogInterface dialog)

public void onStart ()

public static boolean restore (FragmentManager fragmentManager, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback)

Parameters

Returns

public static boolean restore (FragmentManager fragmentManager, NewPageDialog.Callback callback)

Parameters

Returns

public static boolean restore (FragmentManager fragmentManager, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback)

Parameters

Returns

public void setupDialog (Dialog dialog, int style)

public static void show (FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, boolean showPageTemplatesLast, NewPageDialog.Callback callback)

Parameters

public static void show (FragmentManager fragmentManager, Size documentPageSize, NewPageDialog.Callback callback)

Parameters

public static void show (FragmentManager fragmentManager, Size documentPageSize, List<PageTemplate> pageTemplates, NewPageDialog.Callback callback)

Parameters

Protected Methods

protected void onAddButtonClicked ()