Full Screen mode listener & close method

paodb commented 1 month ago

Close #130.

This PR adds a listener to know whether the map is in full screen mode. Also a method to allow to close the full scrren mode programmatically was added.

The enhancement is based on this investigation https://github.com/FlowingCode/GoogleMapsAddon/issues/130#issuecomment-2153396439

The example in the comment would now be reduced to add a FullScreenEvent listener by calling addFullScreenListener and calling closeFullScreen method if full screen mode is on:

private boolean isFullScreen = false;
...

Button openDialogButton = new Button("Open Dialog", e -> {
Dialog d = new Dialog(new Span("I'm a dialog"));
...
if (isFullScreen) { // if full screen is on, close it so dialog can be visible
   gmaps.closeFullScreen();
}
d.open();
});
...

// add listener to know if full screen mode is on 
gmaps.addFullScreenListener(e -> this.isFullScreen = e.isFullScreen());

Summary by CodeRabbit

New Features
- Introduced full-screen mode handling for Google Maps.
- Added functionality to listen for full-screen events.
- Enabled closing of full-screen mode directly from the map interface.

coderabbitai[bot] commented 1 month ago

Walkthrough

The GoogleMap.java file in the com.flowingcode.vaadin.addons.googlemaps package has been enhanced to manage full-screen mode. Two new methods, addFullScreenListener and closeFullScreen, and a nested class FullScreenEvent have been added to facilitate handling full-screen events and programmatically closing full-screen mode.

Changes

File Path	Change Summary
`src/main/java/com/flowingcode/vaadin/addons/googlemaps/GoogleMap.java`	Added methods `addFullScreenListener` and `closeFullScreen`, and nested class `FullScreenEvent` to handle full-screen events.

Assessment against linked issues

Objective	Addressed	Explanation
Ability to listen to full-screen events (#130)	✅
API to revert to non full-screen mode programmatically (#130)	✅
Provide user feedback or hint regarding dialog visibility in full-screen mode (#130)	❌	No specific user feedback or hints are implemented to inform users about dialog visibility in full-screen mode.

Poem

In the land of maps, a change unfolds,
Full-screen mode, a story told.
With listeners keen and methods bright,
Dialogs hidden now in sight.
A rabbit's cheer for code so grand,
Enhancing maps across the land.
🗺️✨🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.