From 2e6ee12a1aca5c98e6e90e36c62277cf61f6d2dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Hohwiller?= Date: Sun, 11 Feb 2024 19:24:17 +0100 Subject: [PATCH] JavaDoc fixes --- .../mmm/ui/api/controller/UiController.java | 2 +- .../api/widget/data/UiAbstractDataTable.java | 1 - .../widget/form/UiCustomHorizontalInput.java | 6 ++-- .../widget/form/UiCustomVerticalInput.java | 34 +++++++++++++++++++ .../mmm/ui/api/widget/form/UiFormPanel.java | 2 -- .../widget/menu/UiAbstractMenuWithItems.java | 1 - .../ui/api/window/notiy/UiPopupNotifier.java | 2 -- 7 files changed, 38 insertions(+), 10 deletions(-) create mode 100644 form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomVerticalInput.java diff --git a/controller/src/main/java/io/github/mmm/ui/api/controller/UiController.java b/controller/src/main/java/io/github/mmm/ui/api/controller/UiController.java index 3c76549..28b02f2 100644 --- a/controller/src/main/java/io/github/mmm/ui/api/controller/UiController.java +++ b/controller/src/main/java/io/github/mmm/ui/api/controller/UiController.java @@ -56,7 +56,7 @@ public interface UiController /** * The ID of a controller should only contain ASCII letters, Latin digits, hyphens or underscores. It may also contain - * slashes ('/') or the hash sign ('#'). It must not contain '?', '&', '=', ':', ';', '\\' or ' '. + * slashes ('/') or the hash sign ('#'). It must not contain '?', '{@literal &}', '=', ':', ';', '\\' or ' '. * * @see #ID_ROOT * @see #ID_PAGE diff --git a/data/src/main/java/io/github/mmm/ui/api/widget/data/UiAbstractDataTable.java b/data/src/main/java/io/github/mmm/ui/api/widget/data/UiAbstractDataTable.java index d1ee5a2..c0a594b 100644 --- a/data/src/main/java/io/github/mmm/ui/api/widget/data/UiAbstractDataTable.java +++ b/data/src/main/java/io/github/mmm/ui/api/widget/data/UiAbstractDataTable.java @@ -67,7 +67,6 @@ default void addColumn(UiColumn column) { /** * @param type of the cell values of the {@link UiColumn}. * @param property the {@link PropertyPath property} of the row data. - * @param index the index where to add the new column. * @return the new {@link UiColumn}. * @throws RuntimeException if the given {@code property} does not belong to the data model of this data widget. */ diff --git a/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomHorizontalInput.java b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomHorizontalInput.java index b53aa01..a21e2b8 100644 --- a/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomHorizontalInput.java +++ b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomHorizontalInput.java @@ -3,15 +3,15 @@ package io.github.mmm.ui.api.widget.form; import io.github.mmm.ui.api.factory.UiWidgetFactoryNative; -import io.github.mmm.ui.api.widget.AbstractUiCustomWidget; /** - * {@link AbstractUiCustomWidget} that is a {@link UiFormPanel}. + * {@link UiCustomCompositeInput} that is a {@link UiHorizontalInput}. * * @param type of the {@link #getValue() value}. * @since 1.0.0 */ -public class UiCustomHorizontalInput extends UiCustomCompositeInput> implements UiHorizontalInput { +public class UiCustomHorizontalInput extends UiCustomCompositeInput> + implements UiHorizontalInput { /** * The constructor. diff --git a/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomVerticalInput.java b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomVerticalInput.java new file mode 100644 index 0000000..b70e51d --- /dev/null +++ b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiCustomVerticalInput.java @@ -0,0 +1,34 @@ +/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0 + * http://www.apache.org/licenses/LICENSE-2.0 */ +package io.github.mmm.ui.api.widget.form; + +import io.github.mmm.ui.api.factory.UiWidgetFactoryNative; + +/** + * {@link UiCustomCompositeInput} that is a {@link UiVerticalInput}. + * + * @param type of the {@link #getValue() value}. + * @since 1.0.0 + */ +public class UiCustomVerticalInput extends UiCustomCompositeInput> + implements UiVerticalInput { + + /** + * The constructor. + */ + public UiCustomVerticalInput() { + + super(UiWidgetFactoryNative.get().create(UiVerticalInput.class)); + } + + /** + * The constructor. + * + * @param delegate the {@link UiHorizontalInput}. + */ + public UiCustomVerticalInput(UiVerticalInput delegate) { + + super(delegate); + } + +} diff --git a/form/src/main/java/io/github/mmm/ui/api/widget/form/UiFormPanel.java b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiFormPanel.java index c501e34..6b35d3f 100644 --- a/form/src/main/java/io/github/mmm/ui/api/widget/form/UiFormPanel.java +++ b/form/src/main/java/io/github/mmm/ui/api/widget/form/UiFormPanel.java @@ -2,7 +2,6 @@ * http://www.apache.org/licenses/LICENSE-2.0 */ package io.github.mmm.ui.api.widget.form; -import io.github.mmm.ui.api.attribute.AttributeWriteValueForUser; import io.github.mmm.ui.api.binding.UiValueBinding; import io.github.mmm.ui.api.factory.UiWidgetFactoryNative; import io.github.mmm.ui.api.widget.UiNativeWidget; @@ -34,7 +33,6 @@ static UiFormPanel of() { /** * @param type of the {@link #getValue() value}. - * @param binding the {@link AttributeWriteValueForUser} defining how to read and write the value. * @param children the {@link UiAbstractInput}s to add as children. * @return the new {@link UiFormPanel}. */ diff --git a/menu/src/main/java/io/github/mmm/ui/api/widget/menu/UiAbstractMenuWithItems.java b/menu/src/main/java/io/github/mmm/ui/api/widget/menu/UiAbstractMenuWithItems.java index fb4f44f..48e857e 100644 --- a/menu/src/main/java/io/github/mmm/ui/api/widget/menu/UiAbstractMenuWithItems.java +++ b/menu/src/main/java/io/github/mmm/ui/api/widget/menu/UiAbstractMenuWithItems.java @@ -36,7 +36,6 @@ default UiMenuItem addItem(String text, UiClickEventListener listener) { /** * @param action the {@link UiAction} to bind. - * @param index is the {@link #getChildIndex(UiAbstractMenuEntry) index} where to insert the new {@link UiMenuItem}. * @return the created and added {@link UiMenuItem}. */ default UiMenuItem addItem(UiAction action) { diff --git a/window/src/main/java/io/github/mmm/ui/api/window/notiy/UiPopupNotifier.java b/window/src/main/java/io/github/mmm/ui/api/window/notiy/UiPopupNotifier.java index b580ca5..ded73f2 100644 --- a/window/src/main/java/io/github/mmm/ui/api/window/notiy/UiPopupNotifier.java +++ b/window/src/main/java/io/github/mmm/ui/api/window/notiy/UiPopupNotifier.java @@ -36,8 +36,6 @@ public interface UiPopupNotifier extends UiNotifier { * flexible but also the most inconvenient {@code showPopup} method variant. * * @param notification the {@link UiNotification} to show. - * @param actions are the {@link UiAction}s for the buttons to close (answer, confirm, or cancel) the popup. Has to be - * at least one {@link UiAction}. * @return the {@link UiPopup}. */ default UiPopup createPopupOk(UiNotification notification) {