io.flutter.plugin.platform.PlatformPlugin Class Reference

Classes
interface	PlatformPluginDelegate

Public Member Functions
	PlatformPlugin (@NonNull Activity activity, @NonNull PlatformChannel platformChannel)
	PlatformPlugin ( @NonNull Activity activity, @NonNull PlatformChannel platformChannel, @Nullable PlatformPluginDelegate delegate)
void	destroy ()
void	updateSystemUiOverlays ()

Static Public Attributes
static final int	DEFAULT_SYSTEM_UI

Package Functions
void	vibrateHapticFeedback ( @NonNull PlatformChannel.HapticFeedbackType feedbackType)

Package Attributes
final PlatformChannel.PlatformMessageHandler	mPlatformMessageHandler

Detailed Description

Android implementation of the platform plugin.

Definition at line 36 of file PlatformPlugin.java.

Constructor & Destructor Documentation

PlatformPlugin() [1/2]

io.flutter.plugin.platform.PlatformPlugin.PlatformPlugin ( @NonNull Activity  activity, @NonNull PlatformChannel  platformChannel  )

inline

Definition at line 158 of file PlatformPlugin.java.

                                                                                              {
    this(activity, platformChannel, null);
  }

PlatformPlugin() [2/2]

io.flutter.plugin.platform.PlatformPlugin.PlatformPlugin ( @NonNull Activity  activity, @NonNull PlatformChannel  platformChannel, @Nullable PlatformPluginDelegate  delegate  )

inline

Definition at line 162 of file PlatformPlugin.java.

                                                 {
    this.activity = activity;
    this.platformChannel = platformChannel;
    this.platformChannel.setPlatformMessageHandler(mPlatformMessageHandler);
    this.platformPluginDelegate = delegate;
 
    mEnabledOverlays = DEFAULT_SYSTEM_UI;
  }

Member Function Documentation

destroy()

void io.flutter.plugin.platform.PlatformPlugin.destroy ( )

inline

Releases all resources held by this PlatformPlugin.

Do not invoke any methods on a PlatformPlugin after invoking this method.

Definition at line 179 of file PlatformPlugin.java.

                        {
    this.platformChannel.setPlatformMessageHandler(null);
  }

updateSystemUiOverlays()

void io.flutter.plugin.platform.PlatformPlugin.updateSystemUiOverlays ( )

inline

Refreshes Android's window system UI (AKA system chrome) to match Flutter's desired PlatformChannel.SystemChromeStyle.

Updating the system UI Overlays is accomplished by altering the decor view of the Window associated with the android.app.Activity that was provided to this
PlatformPlugin.

Definition at line 372 of file PlatformPlugin.java.

                                       {
    activity.getWindow().getDecorView().setSystemUiVisibility(mEnabledOverlays);
    if (currentTheme != null) {
      setSystemChromeSystemUIOverlayStyle(currentTheme);
    }
  }

vibrateHapticFeedback()

void io.flutter.plugin.platform.PlatformPlugin.vibrateHapticFeedback ( @NonNull PlatformChannel.HapticFeedbackType  feedbackType )

inlinepackage

Definition at line 191 of file PlatformPlugin.java.

                                                                {
    View view = activity.getWindow().getDecorView();
    switch (feedbackType) {
      case STANDARD:
        view.performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
        break;
      case LIGHT_IMPACT:
        view.performHapticFeedback(HapticFeedbackConstants.VIRTUAL_KEY);
        break;
      case MEDIUM_IMPACT:
        view.performHapticFeedback(HapticFeedbackConstants.KEYBOARD_TAP);
        break;
      case HEAVY_IMPACT:
        if (Build.VERSION.SDK_INT >= API_LEVELS.API_23) {
          view.performHapticFeedback(HapticFeedbackConstants.CONTEXT_CLICK);
        }
        break;
      case SELECTION_CLICK:
        view.performHapticFeedback(HapticFeedbackConstants.CLOCK_TICK);
        break;
    }
  }

Member Data Documentation

DEFAULT_SYSTEM_UI

final int io.flutter.plugin.platform.PlatformPlugin.DEFAULT_SYSTEM_UI

static

Initial value:

=
      View.SYSTEM_UI_FLAG_LAYOUT_STABLE | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN

Definition at line 37 of file PlatformPlugin.java.

mPlatformMessageHandler

final PlatformChannel.PlatformMessageHandler io.flutter.plugin.platform.PlatformPlugin.mPlatformMessageHandler

package

Definition at line 76 of file PlatformPlugin.java.

                                                   {
        @Override
        public void playSystemSound(@NonNull PlatformChannel.SoundType soundType) {
          PlatformPlugin.this.playSystemSound(soundType);
        }
 
        @Override
        public void vibrateHapticFeedback(
            @NonNull PlatformChannel.HapticFeedbackType feedbackType) {
          PlatformPlugin.this.vibrateHapticFeedback(feedbackType);
        }
 
        @Override
        public void setPreferredOrientations(int androidOrientation) {
          setSystemChromePreferredOrientations(androidOrientation);
        }
 
        @Override
        public void setApplicationSwitcherDescription(
            @NonNull PlatformChannel.AppSwitcherDescription description) {
          setSystemChromeApplicationSwitcherDescription(description);
        }
 
        @Override
        public void showSystemOverlays(@NonNull List<PlatformChannel.SystemUiOverlay> overlays) {
          setSystemChromeEnabledSystemUIOverlays(overlays);
        }
 
        @Override
        public void showSystemUiMode(@NonNull PlatformChannel.SystemUiMode mode) {
          setSystemChromeEnabledSystemUIMode(mode);
        }
 
        @Override
        public void setSystemUiChangeListener() {
          setSystemChromeChangeListener();
        }
 
        @Override
        public void restoreSystemUiOverlays() {
          restoreSystemChromeSystemUIOverlays();
        }
 
        @Override
        public void setSystemUiOverlayStyle(
            @NonNull PlatformChannel.SystemChromeStyle systemUiOverlayStyle) {
          setSystemChromeSystemUIOverlayStyle(systemUiOverlayStyle);
        }
 
        @Override
        public void setFrameworkHandlesBack(boolean frameworkHandlesBack) {
          PlatformPlugin.this.setFrameworkHandlesBack(frameworkHandlesBack);
        }
 
        @Override
        public void popSystemNavigator() {
          PlatformPlugin.this.popSystemNavigator();
        }
 
        @Override
        public CharSequence getClipboardData(
            @Nullable PlatformChannel.ClipboardContentFormat format) {
          return PlatformPlugin.this.getClipboardData(format);
        }
 
        @Override
        public void setClipboardData(@NonNull String text) {
          PlatformPlugin.this.setClipboardData(text);
        }
 
        @Override
        public boolean clipboardHasStrings() {
          return PlatformPlugin.this.clipboardHasStrings();
        }
 
        @Override
        public void share(@NonNull String text) {
          PlatformPlugin.this.share(text);
        }
      };

---

The documentation for this class was generated from the following file:

• shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java