Clarify warning comment for setEnabled #10075
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pleku
approved these changes
Mar 2, 2021
| @@ -74,6 +74,9 @@ default void setEnabled(boolean enabled) { | |||
| * XXX WARNING Do not override this method. Propagating the enabled | |||
| * state to the element in this way is critical to fulfill generic | |||
| * assumptions with regards to application security. | |||
| * | |||
| * Override Component::onEnabledStateChanged if you need to adjust how | |||
| * the disabled state is visually represented in the browser. | |||
There was a problem hiding this comment.
Just commenting that it is slightly weird that the warnings are here instead of in the method level javadocs 🤷
There was a problem hiding this comment.
These JavaDocs are directly inherited into each component that uses this interface. The added comments do not make any sense at all for e.g. Button or ComboBo. It's not optimal to have them only in the code either, but it's the best place I could think of that wouldn't pollute everything.
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
vaadin-bot
pushed a commit
that referenced
this pull request
Mar 2, 2021
mshabarov
pushed a commit
that referenced
this pull request
Mar 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.