// Copyright 2014 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import 'package:flutter/cupertino.dart'; import 'package:flutter/rendering.dart'; import 'debug.dart'; import 'desktop_text_selection_toolbar.dart'; import 'desktop_text_selection_toolbar_button.dart'; import 'material_localizations.dart'; import 'text_selection_toolbar.dart'; import 'text_selection_toolbar_text_button.dart'; import 'theme.dart'; /// The default context menu for text selection for the current platform. /// /// {@template flutter.material.AdaptiveTextSelectionToolbar.contextMenuBuilders} /// Typically, this widget would be passed to `contextMenuBuilder` in a /// supported parent widget, such as: /// /// * [EditableText.contextMenuBuilder] /// * [TextField.contextMenuBuilder] /// * [CupertinoTextField.contextMenuBuilder] /// * [SelectionArea.contextMenuBuilder] /// * [SelectableText.contextMenuBuilder] /// {@endtemplate} /// /// See also: /// /// * [EditableText.getEditableButtonItems], which returns the default /// [ContextMenuButtonItem]s for [EditableText] on the platform. /// * [AdaptiveTextSelectionToolbar.getAdaptiveButtons], which builds the button /// Widgets for the current platform given [ContextMenuButtonItem]s. /// * [CupertinoAdaptiveTextSelectionToolbar], which does the same thing as this /// widget but only for Cupertino context menus. /// * [TextSelectionToolbar], the default toolbar for Android. /// * [DesktopTextSelectionToolbar], the default toolbar for desktop platforms /// other than MacOS. /// * [CupertinoTextSelectionToolbar], the default toolbar for iOS. /// * [CupertinoDesktopTextSelectionToolbar], the default toolbar for MacOS. class AdaptiveTextSelectionToolbar extends StatelessWidget { /// Create an instance of [AdaptiveTextSelectionToolbar] with the /// given [children]. /// /// See also: /// /// {@template flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// * [AdaptiveTextSelectionToolbar.buttonItems], which takes a list of /// [ContextMenuButtonItem]s instead of [children] widgets. /// {@endtemplate} /// {@template flutter.material.AdaptiveTextSelectionToolbar.editable} /// * [AdaptiveTextSelectionToolbar.editable], which builds the default /// children for an editable field. /// {@endtemplate} /// {@template flutter.material.AdaptiveTextSelectionToolbar.editableText} /// * [AdaptiveTextSelectionToolbar.editableText], which builds the default /// children for an [EditableText]. /// {@endtemplate} /// {@template flutter.material.AdaptiveTextSelectionToolbar.selectable} /// * [AdaptiveTextSelectionToolbar.selectable], which builds the default /// children for content that is selectable but not editable. /// {@endtemplate} const AdaptiveTextSelectionToolbar({ super.key, required this.children, required this.anchors, }) : buttonItems = null; /// Create an instance of [AdaptiveTextSelectionToolbar] whose children will /// be built from the given [buttonItems]. /// /// See also: /// /// {@template flutter.material.AdaptiveTextSelectionToolbar.new} /// * [AdaptiveTextSelectionToolbar.new], which takes the children directly as /// a list of widgets. /// {@endtemplate} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editable} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editableText} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.selectable} const AdaptiveTextSelectionToolbar.buttonItems({ super.key, required this.buttonItems, required this.anchors, }) : children = null; /// Create an instance of [AdaptiveTextSelectionToolbar] with the default /// children for an editable field. /// /// If a callback is null, then its corresponding button will not be built. /// /// See also: /// /// {@macro flutter.material.AdaptiveTextSelectionToolbar.new} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editableText} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.selectable} AdaptiveTextSelectionToolbar.editable({ super.key, required ClipboardStatus clipboardStatus, required VoidCallback? onCopy, required VoidCallback? onCut, required VoidCallback? onPaste, required VoidCallback? onSelectAll, required this.anchors, }) : children = null, buttonItems = EditableText.getEditableButtonItems( clipboardStatus: clipboardStatus, onCopy: onCopy, onCut: onCut, onPaste: onPaste, onSelectAll: onSelectAll, ); /// Create an instance of [AdaptiveTextSelectionToolbar] with the default /// children for an [EditableText]. /// /// See also: /// /// {@macro flutter.material.AdaptiveTextSelectionToolbar.new} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editable} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.selectable} AdaptiveTextSelectionToolbar.editableText({ super.key, required EditableTextState editableTextState, }) : children = null, buttonItems = editableTextState.contextMenuButtonItems, anchors = editableTextState.contextMenuAnchors; /// Create an instance of [AdaptiveTextSelectionToolbar] with the default /// children for selectable, but not editable, content. /// /// See also: /// /// {@macro flutter.material.AdaptiveTextSelectionToolbar.new} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editable} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editableText} AdaptiveTextSelectionToolbar.selectable({ super.key, required VoidCallback onCopy, required VoidCallback onSelectAll, required SelectionGeometry selectionGeometry, required this.anchors, }) : children = null, buttonItems = SelectableRegion.getSelectableButtonItems( selectionGeometry: selectionGeometry, onCopy: onCopy, onSelectAll: onSelectAll, ); /// Create an instance of [AdaptiveTextSelectionToolbar] with the default /// children for a [SelectableRegion]. /// /// See also: /// /// {@macro flutter.material.AdaptiveTextSelectionToolbar.new} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editable} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.editableText} /// {@macro flutter.material.AdaptiveTextSelectionToolbar.selectable} AdaptiveTextSelectionToolbar.selectableRegion({ super.key, required SelectableRegionState selectableRegionState, }) : children = null, buttonItems = selectableRegionState.contextMenuButtonItems, anchors = selectableRegionState.contextMenuAnchors; /// {@template flutter.material.AdaptiveTextSelectionToolbar.buttonItems} /// The [ContextMenuButtonItem]s that will be turned into the correct button /// widgets for the current platform. /// {@endtemplate} final List<ContextMenuButtonItem>? buttonItems; /// The children of the toolbar, typically buttons. final List<Widget>? children; /// {@template flutter.material.AdaptiveTextSelectionToolbar.anchors} /// The location on which to anchor the menu. /// {@endtemplate} final TextSelectionToolbarAnchors anchors; /// Returns the default button label String for the button of the given /// [ContextMenuButtonType] on any platform. static String getButtonLabel(BuildContext context, ContextMenuButtonItem buttonItem) { if (buttonItem.label != null) { return buttonItem.label!; } switch (Theme.of(context).platform) { case TargetPlatform.iOS: case TargetPlatform.macOS: return CupertinoTextSelectionToolbarButton.getButtonLabel( context, buttonItem, ); case TargetPlatform.android: case TargetPlatform.fuchsia: case TargetPlatform.linux: case TargetPlatform.windows: assert(debugCheckHasMaterialLocalizations(context)); final MaterialLocalizations localizations = MaterialLocalizations.of(context); switch (buttonItem.type) { case ContextMenuButtonType.cut: return localizations.cutButtonLabel; case ContextMenuButtonType.copy: return localizations.copyButtonLabel; case ContextMenuButtonType.paste: return localizations.pasteButtonLabel; case ContextMenuButtonType.selectAll: return localizations.selectAllButtonLabel; case ContextMenuButtonType.delete: return localizations.deleteButtonTooltip.toUpperCase(); case ContextMenuButtonType.custom: return ''; } } } /// Returns a List of Widgets generated by turning [buttonItems] into the /// default context menu buttons for the current platform. /// /// This is useful when building a text selection toolbar with the default /// button appearance for the given platform, but where the toolbar and/or the /// button actions and labels may be custom. /// /// {@tool dartpad} /// This sample demonstrates how to use `getAdaptiveButtons` to generate /// default button widgets in a custom toolbar. /// /// ** See code in examples/api/lib/material/context_menu/editable_text_toolbar_builder.2.dart ** /// {@end-tool} /// /// See also: /// /// * [CupertinoAdaptiveTextSelectionToolbar.getAdaptiveButtons], which is the /// Cupertino equivalent of this class and builds only the Cupertino /// buttons. static Iterable<Widget> getAdaptiveButtons(BuildContext context, List<ContextMenuButtonItem> buttonItems) { switch (Theme.of(context).platform) { case TargetPlatform.iOS: return buttonItems.map((ContextMenuButtonItem buttonItem) { return CupertinoTextSelectionToolbarButton.text( onPressed: buttonItem.onPressed, text: getButtonLabel(context, buttonItem), ); }); case TargetPlatform.fuchsia: case TargetPlatform.android: final List<Widget> buttons = <Widget>[]; for (int i = 0; i < buttonItems.length; i++) { final ContextMenuButtonItem buttonItem = buttonItems[i]; buttons.add(TextSelectionToolbarTextButton( padding: TextSelectionToolbarTextButton.getPadding(i, buttonItems.length), onPressed: buttonItem.onPressed, child: Text(getButtonLabel(context, buttonItem)), )); } return buttons; case TargetPlatform.linux: case TargetPlatform.windows: return buttonItems.map((ContextMenuButtonItem buttonItem) { return DesktopTextSelectionToolbarButton.text( context: context, onPressed: buttonItem.onPressed, text: getButtonLabel(context, buttonItem), ); }); case TargetPlatform.macOS: return buttonItems.map((ContextMenuButtonItem buttonItem) { return CupertinoDesktopTextSelectionToolbarButton.text( context: context, onPressed: buttonItem.onPressed, text: getButtonLabel(context, buttonItem), ); }); } } @override Widget build(BuildContext context) { // If there aren't any buttons to build, build an empty toolbar. if ((children != null && children!.isEmpty) || (buttonItems != null && buttonItems!.isEmpty)) { return const SizedBox.shrink(); } final List<Widget> resultChildren = children != null ? children! : getAdaptiveButtons(context, buttonItems!).toList(); switch (Theme.of(context).platform) { case TargetPlatform.iOS: return CupertinoTextSelectionToolbar( anchorAbove: anchors.primaryAnchor, anchorBelow: anchors.secondaryAnchor == null ? anchors.primaryAnchor : anchors.secondaryAnchor!, children: resultChildren, ); case TargetPlatform.android: return TextSelectionToolbar( anchorAbove: anchors.primaryAnchor, anchorBelow: anchors.secondaryAnchor == null ? anchors.primaryAnchor : anchors.secondaryAnchor!, children: resultChildren, ); case TargetPlatform.fuchsia: case TargetPlatform.linux: case TargetPlatform.windows: return DesktopTextSelectionToolbar( anchor: anchors.primaryAnchor, children: resultChildren, ); case TargetPlatform.macOS: return CupertinoDesktopTextSelectionToolbar( anchor: anchors.primaryAnchor, children: resultChildren, ); } } }