Skip to content

Commit 1e37cb3

Browse files
authored
docs: fix typos and trailing whitespaces (#4785)
1 parent 4b770a7 commit 1e37cb3

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

articles/building-apps/forms-data/add-form/validation/flow.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Vaadin provides a set of *built-in validators* for common validation scenarios:
6767

6868
* *Numeric Range Validators* -- Ensure that a numeric value falls within a valid range.
6969
- `BigDecimalRangeValidator`, `BigIntegerRangeValidator`, `ByteRangeValidator`, `DoubleRangeValidator`, `FloatRangeValidator`, `IntegerRangeValidator`, `LongRangeValidator`, `ShortRangeValidator`
70-
70+
7171
* *Date Validators* -- Ensure that a date or time value falls within a valid range.
7272
- `DateRangeValidator`, `DateTimeRangeValidator`
7373

@@ -114,7 +114,7 @@ binder.forField(myNumberField)
114114

115115
=== Converters
116116

117-
If you're using value objects or domain primitives in your FDO, you can create a converter by implementing [interfacename]`Converter<T>`. The following example converts between an [clasname]`EmailAddress` and a [classname]`String`:
117+
If you're using value objects or domain primitives in your FDO, you can create a converter by implementing [interfacename]`Converter<T>`. The following example converts between an [classname]`EmailAddress` and a [classname]`String`:
118118

119119
.EmailAddressConverter.java
120120
[source,java]
@@ -134,7 +134,7 @@ public class EmailAddressConverter implements Converter<String, EmailAddress> {
134134
}
135135
136136
@Override
137-
public String convertToPresentation(EmailAddress emailAddress,
137+
public String convertToPresentation(EmailAddress emailAddress,
138138
ValueContext context) {
139139
return emailAddress == null ? null : emailAddress.toString();
140140
}
@@ -158,7 +158,7 @@ You can add validators after the converter as well. For example, if you need to
158158
----
159159
binder.forField(myEmailAddress)
160160
.withConverter(new EmailAddressConverter())
161-
.withValidator(emailValidationService::notAlreadyInUse,
161+
.withValidator(emailValidationService::notAlreadyInUse,
162162
"The email address is already in use")
163163
.bind(myBean::getEmail, myBean::setEmail);
164164
----
@@ -205,7 +205,7 @@ The following example ensures that the start date is not after the end date:
205205
[source,java]
206206
----
207207
binder.withValidator((bean, valueContext) -> {
208-
if (bean.getStartDate() != null && bean.getEndDate() != null
208+
if (bean.getStartDate() != null && bean.getEndDate() != null
209209
&& bean.getStartDate().isAfter(bean.getEndDate())) {
210210
return ValidationResult.error("Start date cannot be after end date");
211211
}
@@ -257,4 +257,4 @@ This ensures that validation messages are displayed appropriately, whenever they
257257

258258
//== Try It
259259

260-
//- TODO Write a tutorial here
260+
//- TODO Write a tutorial here

articles/building-apps/forms-data/consistency/transactions/declarative.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public class MyApplicationService {
6868
@Transactional
6969
public void myMethod(MyInput input) {
7070
if (!isValid(input)) {
71-
throw new IllegalArgumentExcpetion("Bad input");
71+
throw new IllegalArgumentException("Bad input");
7272
}
7373
...
7474
}
@@ -116,7 +116,7 @@ public class MyApplicationService {
116116

117117
== Caveats
118118

119-
When working with declarative transactions, it's important to remember that the annotations themselves don't manage any transactions. They're merely instructions for how Spring should manage the transactions.
119+
When working with declarative transactions, it's important to remember that the annotations themselves don't manage any transactions. They're merely instructions for how Spring should manage the transactions.
120120

121121
During application startup, Spring detects the `@Transactional` annotation and turns the service into a proxy. When a client calls the proxy, the call is routed through a _method interceptor_. The interceptor starts the transaction, calls the actual method, and then commits the transaction when the method returns, as illustrated in this diagram:
122122

@@ -141,12 +141,12 @@ public class MyApplicationService {
141141
public void mySecondMethod() {
142142
// myFirstMethod() will participate in the transaction of mySecondMethod(),
143143
// even though it has been annotated as REQUIRES_NEW.
144-
myFirstMethod();
144+
myFirstMethod();
145145
}
146146
}
147147
----
148148

149149
You can fix this by managing the transactions, <<programmatic#,programmatically>>.
150150

151-
// Actually, you can fix it by using AspectJ proxies as well, but I don't want to go there.
152-
151+
// Actually, you can fix it by using AspectJ proxies as well, but I don't want to go there.
152+

articles/building-apps/security/add-login/flow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ public class TaskListView extends Main {
323323
----
324324
325325
[NOTE]
326-
[annotationame]`@PermitAll` allows _all authenticated users_ to access the view.
326+
[annotationname]`@PermitAll` allows _all authenticated users_ to access the view.
327327
328328
====
329329

articles/building-apps/security/protect-views/flow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The easiest way to grant or deny access to a Flow view is to use annotations. Th
2424
[NOTE]
2525
The `@AnonymousAllowed` annotation is a Vaadin-specific annotation; the others are Jakarta annotations (JSR-250). The Spring Security annotations `@Secured` and `@PreAuthorize` are *not supported on views*.
2626

27-
The following example uses [annoationname]`@AnonymousAllowed` to allow *all users* -- both authenticated and unauthenticated -- to access the view:
27+
The following example uses [annotationname]`@AnonymousAllowed` to allow *all users* -- both authenticated and unauthenticated -- to access the view:
2828

2929
[source,java]
3030
----

articles/components/upload/file-handling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The uploading of files may be handled either with Vaadin Flow using Java, or wit
1616

1717
The Java Flow Upload component provides an API to handle directly uploaded file data, without having to set up an endpoint or a servlet. It uses an [classname]`UploadHandler` implementation to handle the incoming file data.
1818

19-
[classname]`UploadHandler` is a functional interface that only requires the [methodame]`handleUploadRequest(UploadEvent)` to be implemented for receiving data or use one of the built-in implementations.
19+
[classname]`UploadHandler` is a functional interface that only requires the [methodname]`handleUploadRequest(UploadEvent)` to be implemented for receiving data or use one of the built-in implementations.
2020

2121
The following built-in implementations of [classname]`UploadHandler` are available:
2222

articles/designing-apps/color.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Should you need help generating a color palette, there are many tools available
2727
Lumo's <</styling/lumo/lumo-style-properties/color#,color palette>> consists of grayscale shades, blue as the primary color, red for errors, green for success, yellow for warnings, and text colors:
2828

2929
.Lumo's Color Palette
30-
image::images/color-palette.png[A grid of colors, with a color scale for grayscale, blue, red, greend, and yellow.]
30+
image::images/color-palette.png[A grid of colors, with a color scale for grayscale, blue, red, green, and yellow.]
3131

3232
Follow the “less is more” approach when using color in your application. Limiting your color palette to a few strategic choices -- such as one primary color, a couple of accent shades, and neutral tones -- helps to create a clean, cohesive interface. This reduces visual clutter and ensures that important elements stand out. Keep it simple for a more intuitive and focused user experience.
3333

articles/flow/advanced/signals.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -239,16 +239,16 @@ public class PersonList extends VerticalLayout {
239239
private final ListSignal<String> persons =
240240
SignalFactory.IN_MEMORY_SHARED.list("persons", String.class);
241241
242-
public PersonList() {
242+
public PersonList() {
243243
Button addButton = new Button("Add Person", click -> {
244244
persons.insertFirst("New person");
245245
});
246-
246+
247247
Button updateButton = new Button("Update first Person", click -> {
248248
ValueSignal<String> first = persons.value().get(0);
249249
first.update(text -> text + " updated");
250250
});
251-
251+
252252
UnorderedList list = new UnorderedList();
253253
ComponentEffect.effect(list, () -> {
254254
list.removeAll();
@@ -264,7 +264,7 @@ public class PersonList extends VerticalLayout {
264264
}
265265
----
266266

267-
Removing all list items and creating them again is not the most efficent soltuion. A helper method will be added later to bind child components in a more efficient way.
267+
Removing all list items and creating them again is not the most efficient solution. A helper method will be added later to bind child components in a more efficient way.
268268

269269
The effect that creates new list item components will be run only when a new item is added to the list but not when the value of an existing item is updated.
270270

@@ -343,7 +343,7 @@ If that is not possible and you are certain there's no risk for infinite loops,
343343

344344
[source,java]
345345
----
346-
CompnentEffect.effect(() -> {
346+
ComponentEffect.effect(() -> {
347347
String value = oneSignal.value();
348348
349349
// This might lead to infinite loops.

articles/flow/testing/end-to-end/advanced-concepts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ class FirefoxParameterizedIT extends AbstractParameterizedTest {
320320
----
321321
--
322322

323-
Parameterized tests can also run on multiple remote browsers, using a similar setup. The main difference is that the base class should be annotated with [annotionname]`@RunOnHub`, and the subclasses should have a method annotated with [annotationname]`@BrowserConfiguration` that returns a [interfacename]`List` containing a single [classname]`DesiredCapabilities` item. Note that the subclasses must have `public` visibility to work with [annotationname]`@BrowserConfiguration` annotation.
323+
Parameterized tests can also run on multiple remote browsers, using a similar setup. The main difference is that the base class should be annotated with [annotationname]`@RunOnHub`, and the subclasses should have a method annotated with [annotationname]`@BrowserConfiguration` that returns a [interfacename]`List` containing a single [classname]`DesiredCapabilities` item. Note that the subclasses must have `public` visibility to work with [annotationname]`@BrowserConfiguration` annotation.
324324

325325
[.example]
326326
--

articles/tools/mpr/configuration/push.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ order: 3
88

99
= Push & MPR
1010

11-
To enable server push for any navigation target in MPR, add the [annotationame]`@Push` Flow annotation on the Flow application shell class. The application shell class is a plain Java class implementing the [interfacename]`AppShellConfigurator` interface.
11+
To enable server push for any navigation target in MPR, add the [annotationname]`@Push` Flow annotation on the Flow application shell class. The application shell class is a plain Java class implementing the [interfacename]`AppShellConfigurator` interface.
1212

13-
The [annotationame]`@Push` annotation has similar parameters (except for the deprecated ones) as the ones used in the Vaadin 7 and 8.
13+
The [annotationname]`@Push` annotation has similar parameters (except for the deprecated ones) as the ones used in the Vaadin 7 and 8.
1414

1515
See <<{articles}/flow/advanced/server-push#,Server Push>> for instructions how to configure push in Flow and the `@Push` annotation JavaDoc for descriptions on each parameter.
1616

0 commit comments

Comments
 (0)