Skip to content

Commit

Permalink
Fix vale errors
Browse files Browse the repository at this point in the history
  • Loading branch information
peholmst committed Dec 19, 2024
1 parent c41cc3b commit 39d2786
Show file tree
Hide file tree
Showing 15 changed files with 68 additions and 68 deletions.
14 changes: 7 additions & 7 deletions articles/components/auto-crud/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ Auto CRUD requires a Java service that implements the `CrudService<T, ID>` inter
[.example]
--
[source,java]
.EmployeeService.java
.`EmployeeService.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeService.java[tags=snippet,indent=0]
----
[source,java]
.Employee.java
.`Employee.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Employee.java[tags=snippet,indent=0]
----
[source,java]
.EmployeeRepository.java
.`EmployeeRepository.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeRepository.java[tags=snippet,indent=0]
----
Expand Down Expand Up @@ -149,22 +149,22 @@ The following example shows a basic implementation of a custom `CrudService` tha

[.example]
--
.ProductDtoCrudService.java
.`ProductDtoCrudService.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDtoCrudService.java[tags=snippet,indent=0]
----
.ProductDto.java
.`ProductDto.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDto.java[tags=snippet,indent=0]
----
.Product.java
.`Product.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
----
.ProductRepository.java
.`ProductRepository.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]
Expand Down
14 changes: 7 additions & 7 deletions articles/components/auto-form/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ Auto Form requires a Java service that implements the `CrudService<T, ID>` inter
[.example]
--
[source,java]
.EmployeeService.java
.`EmployeeService.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeService.java[tags=snippet,indent=0]
----
[source,java]
.Employee.java
.`Employee.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Employee.java[tags=snippet,indent=0]
----
[source,java]
.EmployeeRepository.java
.`EmployeeRepository.java`
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeRepository.java[tags=snippet,indent=0]
----
Expand Down Expand Up @@ -295,22 +295,22 @@ The following example shows a basic implementation of a custom `FormService` tha

[.example]
--
.ProductDtoFormService.java
.`ProductDtoFormService.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDtoFormService.java[tags=snippet,indent=0]
----
.ProductDto.java
.`ProductDto.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDto.java[tags=snippet,indent=0]
----
.Product.java
.`Product.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
----
.ProductRepository.java
.`ProductRepository.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]
Expand Down
24 changes: 12 additions & 12 deletions articles/components/auto-grid/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ Auto Grid requires a Java service that implements the `ListService<T>` interface

[.example]
--
.ProductService.java
.`ProductService.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductService.java[tags=snippet,indent=0]
----
.Product.java
.`Product.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
----
.Supplier.java
.`Supplier.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Supplier.java[tags=snippet,indent=0]
----
.ProductRepository.java
.`ProductRepository.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]
Expand Down Expand Up @@ -275,22 +275,22 @@ The following example shows a basic implementation of a custom `ListService` tha

[.example]
--
.ProductDtoListService.java
.`ProductDtoListService.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDtoListService.java[tags=snippet,indent=0]
----
.ProductDto.java
.`ProductDto.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDto.java[tags=snippet,indent=0]
----
.Product.java
.`Product.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
----
.ProductRepository.java
.`ProductRepository.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]
Expand All @@ -312,22 +312,22 @@ This example uses a [classname]`FilterTransformer` to adapt filtering and sortin

[.example]
--
.ProductAdvancedDtoListService.java
.`ProductAdvancedDtoListService.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductAdvancedDtoListService.java[tags=snippet,indent=0]
----
.ProductAdvancedDto.java
.`ProductAdvancedDto.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductAdvancedDto.java[tags=snippet,indent=0]
----
.Product.java
.`Product.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
----
.ProductRepository.java
.`ProductRepository.java`
[source,java]
----
include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]
Expand Down
14 changes: 7 additions & 7 deletions articles/flow/advanced/long-running-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The examples used here are based on Spring Boot, but a similar approach can be u

To illustrate how a poorly designed handling of long-running tasks can affect users, consider the following backend service that simulates a long-running task.

.BackendService.java
.`BackendService.java`
[source,java]
----
@Service
Expand All @@ -46,7 +46,7 @@ public class BackendService {

Consider also that the [methodname]`BackendService.longRunningTask()` method is being called from the following Vaadin UI:

.MainView.java
.`MainView.java`
[source,java]
----
@Route("")
Expand Down Expand Up @@ -84,7 +84,7 @@ When the asynchronous task is finished, Vaadin uses <<{articles}/flow/advanced/s

The following example shows how the [methodname]`BackendService.longRunningTask()` method can be adjusted to run asynchronously in a separate thread.

.BackendService.java
.`BackendService.java`
[source,java]
----
@Service
Expand Down Expand Up @@ -115,7 +115,7 @@ With these changes in place, you can change the UI to allow the user to start th
Vaadin can then use the [interfacename]`ListenableFuture` and the [methodname]`UI.access()` method of <<{articles}/flow/advanced/server-push#, Server Push>> to notify the user when the task is completed.
This is how [filename]`MainView.java` could look now:

.MainView.java
.`MainView.java`
[source,java]
----
@Route("")
Expand Down Expand Up @@ -159,7 +159,7 @@ For the above example to work as intended, you need two extra annotations for th

You can make both changes in the same class as illustrated in the following [classname]`Application` class (which both extends [classname]`SpringBootServletInitializer` and implements [interfacename]`AppShellConfigurator`):

.Application.java
.`Application.java`
[source,java]
----
@SpringBootApplication
Expand All @@ -179,7 +179,7 @@ public class Application extends SpringBootServletInitializer implements AppShel
With the Vaadin component <<{articles}/components/progress-bar#, Progress Bar>>, you can provide an indicator that a long-running action is currently in progress.
The following adjusts the above [classname]`MainView` example to show a progress bar when the user clicks the "Start long-running task" button.

.MainView.java
.`MainView.java`
[source,java]
----
@Route("")
Expand Down Expand Up @@ -238,7 +238,7 @@ For your task to be cancellable, the following conditions must be met:

The modified [classname]`MainView` class below shows how to add a [classname]`Button` to cancel the long-running task.

.MainView.java
.`MainView.java`
[source,java]
----
@Route("")
Expand Down
8 changes: 4 additions & 4 deletions articles/flow/advanced/servlet-container-authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For customized authentication, you need to implement a custom [classname]`HttpSe
The following example contains a customized [classname]`Principal` object.
It's assumed that this principal is set as a [classname]`Session` attribute at some point by the application.

.CustomPrincipal.java
.`CustomPrincipal.java`
[source,java]
----
public class CustomPrincipal implements Principal {
Expand All @@ -44,7 +44,7 @@ public class CustomPrincipal implements Principal {
}
----

.CustomHttpServletRequest.java
.`CustomHttpServletRequest.java`
[source,java]
----
public class CustomHttpServletRequest extends HttpServletRequestWrapper {
Expand All @@ -67,7 +67,7 @@ public class CustomHttpServletRequest extends HttpServletRequestWrapper {
}
----

.CustomWebFilter.java
.`CustomWebFilter.java`
[source,java]
----
@WebFilter("/connect")
Expand Down Expand Up @@ -126,7 +126,7 @@ export class MyLogin extends LitElement {

Next, change the above filter to handle the request and set the appropriate principal object in the session.

.CustomWebFilter.java
.`CustomWebFilter.java`
[source,java]
----
@WebFilter("/connect")
Expand Down
2 changes: 1 addition & 1 deletion articles/flow/create-ui/creating-components/mixins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ https://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadi

Were you to create a custom `Tooltip` component, for example, that implements the [interfacename]`HasComponents` and [interfacename]`HasStyle` interfaces, you would do something like this:

.Tooltip.java
.`Tooltip.java`
[source,java]
----
@Tag("sample-tooltip")
Expand Down
2 changes: 1 addition & 1 deletion articles/flow/integrations/embedding/theming.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Both of these are also put into the head element for the embedded components, wh

All other styles are only available inside the web component shadow root and don't reach the outlying context.

.MyExporter.java
.`MyExporter.java`
[source,java]
----
@Theme(themeClass = Material.class)
Expand Down
8 changes: 4 additions & 4 deletions articles/flow/integrations/hilla.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Vaadin includes Hilla dependencies, so no dependency adjustment is needed.

Add a view file, [filename]`HelloView.java`, to the `src/main/java/org/vaadin/example/HelloView.java` sub-directory. It'll be accessible under the path, `/hello` in a browser. Here's an example of that:

.HelloView.java
.`HelloView.java`
[source,java]
----
import com.vaadin.flow.component.button.Button;
Expand Down Expand Up @@ -112,7 +112,7 @@ When using Hilla's `createMenuItems()` utility function to build the main menu i

The [annotationname]`@Menu` annotation should always be used together with the [annotationname]`@Route` annotation as in the following example:

.HelloView.java
.`HelloView.java`
[source,java]
----
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
Expand Down Expand Up @@ -143,7 +143,7 @@ Mode is configurable with [interfacename]`MenuAccessControl` interface with the

The following example changes the default mode to `NEVER` in a Spring Framework application:

.Application.java
.`Application.java`
[source,java]
----
import org.springframework.boot.SpringApplication;
Expand Down Expand Up @@ -171,7 +171,7 @@ public class Application {

This next example changes the default mode to `NEVER` in a non-Spring application by using <<../configuration/properties.adoc#servlet-initialization-parameters,Servlet Initialization Parameters>> `menu.access.control` with value `org.vaadin.example.CustomMenuAccessControl`. [classname]`DefaultMenuAccessControl` implements [interfacename]`MenuAccessControl`:

.org.vaadin.example.CustomMenuAccessControl.java
.`org.vaadin.example.CustomMenuAccessControl.java`
[source,java]
----
import com.vaadin.flow.server.auth.DefaultMenuAccessControl;
Expand Down
2 changes: 1 addition & 1 deletion articles/flow/testing/ui-unit/component-query.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public class PhoneNumberFieldTester extends ComponentTester<PersonFormView.Phone
}
----

.PhoneNumberField.java
.`PhoneNumberField.java`
[source,java]
----
static class PhoneNumberField extends CustomField<String> {
Expand Down
4 changes: 2 additions & 2 deletions articles/flow/testing/ui-unit/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The modality check only works when the modal component is <<{articles}/flow/adva

Sample test of the HelloWorld view.

.HelloWorld.java
.`HelloWorld.java`
[source,java]
----
@Route(value = "", layout = MainLayout.class)
Expand All @@ -193,7 +193,7 @@ public class HelloWorldView extends HorizontalLayout {
[NOTE]
The components are package-protected, so that we can use them directly in the [classname]`UIUnitTest`.

.HelloWorldViewTest.java
.`HelloWorldViewTest.java`
[source,java]
----
class HelloWorldViewTest extends UIUnitTest {
Expand Down
4 changes: 2 additions & 2 deletions articles/getting-started/tutorial/hilla/first-view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ At this point, the application looks okay but it does not do anything. You are n

Start by opening the [classname]`com.example.application.chat.ChatService` class in your IDE. Then add the [annotationname]`@BrowserCallable` annotation to the class, like this:

.ChatService.java
.`ChatService.java`
[source,java]
----
package com.example.application.chat;
Expand All @@ -233,7 +233,7 @@ public class ChatService {

Because Hilla endpoints are protected by default, and you have not added security yet, you also need to add the [annotationname]`@AnonymousAllowed` annotation to the class so that you can test it:

.ChatService.java
.`ChatService.java`
[source,java]
----
package com.example.application.chat;
Expand Down
Loading

0 comments on commit 39d2786

Please sign in to comment.