FloatingView

To prevent the FloatingView from being obscured by display cutouts (notches), use FloatingViewManager.findCutoutSafeArea(activity) to calculate a safe area and pass it to your service.

Note: The Activity must be in portrait orientation and windowLayoutInDisplayCutoutMode must not be set to never.

// 1. In your Activity/Fragment, find the safe area and pass it via Intent
final Intent intent = new Intent(activity, ChatHeadService.class);
intent.putExtra(ChatHeadService.EXTRA_CUTOUT_SAFE_AREA, FloatingViewManager.findCutoutSafeArea(activity));
ContextCompat.startForegroundService(activity, intent);

// 2. In your Service, apply the safe area to the manager
Rect safeArea = (Rect) intent.getParcelableExtra(EXTRA_CUTOUT_SAFE_AREA);
mFloatingViewManager.setSafeInsetRect(safeArea);

To use FloatingView in your Android project, add the JitPack repository to your build.gradle file and then add the dependency.

repositories {
    maven {
        url "https://jitpack.io"
    }
}

dependencies {
  implementation 'com.github.recruit-lifestyle:FloatingView:2.4.4'
}

FloatingView requires specific permissions to display over other apps and run as a foreground service. You must also declare your implementation of the Service in the AndroidManifest.xml.

Required Permissions:

• android.permission.SYSTEM_ALERT_WINDOW
• android.permission.FOREGROUND_SERVICE

Service Declaration Example:

<application ...>
    <service
        android:name="your.package.name.ChatHeadService"
        android:exported="false"/>
</application>

Dynamic methods allow you to change the behavior or appearance of the FloatingView at any time after it has been displayed.

// Examples of dynamic updates
mFloatingViewManager.setDisplayMode(FloatingViewManager.DISPLAY_MODE_SHOW_ALWAYS);
mFloatingViewManager.setTrashViewEnabled(false);
mFloatingViewManager.setFixedTrashIconImage(R.drawable.ic_trash_fixed);

The following methods can be called on FloatingViewManager at any time:

Static options are applied via FloatingViewManager.Options and can only be set when the view is displayed for the first time. They control the initial appearance and movement behavior.

final FloatingViewManager.Options options = new FloatingViewManager.Options();
options.shape = FloatingViewManager.SHAPE_CIRCLE; // or SHAPE_RECTANGLE
options.overMargin = 16; // px
options.moveDirection = FloatingViewManager.MOVE_DIRECTION_NEAREST;
options.usePhysics = true;
options.animateInitialMove = true;
mFloatingViewManager.addViewToWindow(iconView, options);

The FloatingView transitions between different operational states which can be managed via its internal FloatingAnimationHandler (exposed through public methods).

State Transitions

• setNormal(): Transitions the view to a normal state, typically used when it is not interacting with other elements.
• setIntersecting(int centerX, int centerY): Transitions the view to an intersecting state, causing it to animate towards the specified target coordinates (centerX, centerY).
• setFinishing(): Transitions the view to a finishing state, hiding the view and preventing further movement.
• getState(): Returns the current state of the view.

Animation Control

• cancelAnimation(): Immediately cancels any ongoing ValueAnimator used for edge movement.

You can intercept touch events on the FloatingView by using setOnTouchListener. This allows you to respond to user interactions like taps or drags within the floating view's area.

floatingView.setOnTouchListener(new View.OnTouchListener() {
    @Override
    public boolean onTouch(View v, MotionEvent event) {
        // Handle touch events
        return false;
    }
});