diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogAction.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogAction.java index 25b86798..7f0ae94b 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogAction.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogAction.java @@ -4,13 +4,25 @@ import lombok.AllArgsConstructor; import lombok.Data; import net.md_5.bungee.api.chat.BaseComponent; +/** + * Represents a dialog action which will usually appear as a button. + */ @Data @AllArgsConstructor public class DialogAction { + /** + * The text label of the button, mandatory. + */ private BaseComponent label; + /** + * The hover tooltip of the button. + */ private BaseComponent tooltip; + /** + * The width of the button (default: 150). + */ private int width; public DialogAction(BaseComponent label) diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogClickAction.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogClickAction.java index 6a47ec42..4daaf049 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogClickAction.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogClickAction.java @@ -8,6 +8,9 @@ import lombok.experimental.Accessors; import net.md_5.bungee.api.chat.BaseComponent; import net.md_5.bungee.api.chat.ClickEvent; +/** + * Represents a button which may be clicked. + */ @Data @Accessors(fluent = true) @ToString(callSuper = true) @@ -15,6 +18,9 @@ import net.md_5.bungee.api.chat.ClickEvent; public class DialogClickAction extends DialogAction { + /** + * The optional action to take on click. + */ @SerializedName("on_click") private ClickEvent onClick; diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogSubmitAction.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogSubmitAction.java index f3ba3224..b5cbf2ba 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogSubmitAction.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogSubmitAction.java @@ -8,6 +8,10 @@ import lombok.experimental.Accessors; import net.md_5.bungee.api.chat.BaseComponent; import net.md_5.bungee.api.dialog.submit.DialogSubmission; +/** + * Represents a dialog button associated with the submission of a form dialog + * containing inputs. + */ @Data @Accessors(fluent = true) @ToString(callSuper = true) @@ -15,7 +19,14 @@ import net.md_5.bungee.api.dialog.submit.DialogSubmission; public class DialogSubmitAction extends DialogAction { + /** + * The ID of the button, used to distinguish submissions initiated via + * different buttons on the dialog. + */ private String id; + /** + * The submission action to take. + */ @SerializedName("on_submit") private DialogSubmission onSubmit; diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/action/package-info.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/package-info.java new file mode 100644 index 00000000..1ef2090c --- /dev/null +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/action/package-info.java @@ -0,0 +1,4 @@ +/** + * Contains the different actions/buttons for a {@link net.md_5.bungee.api.dialog.Dialog}. + */ +package net.md_5.bungee.api.dialog.action; diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/body/DialogBody.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/DialogBody.java index 5323628f..84501c88 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/body/DialogBody.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/DialogBody.java @@ -1,10 +1,18 @@ package net.md_5.bungee.api.dialog.body; import lombok.Data; +import org.jetbrains.annotations.ApiStatus; +/** + * Represents the body content of a {@link net.md_5.bungee.api.dialog.Dialog}. + */ @Data public abstract class DialogBody { + /** + * The internal body type. + */ + @ApiStatus.Internal private final String type; } diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/body/PlainMessageBody.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/PlainMessageBody.java index 52108dc5..6d710273 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/body/PlainMessageBody.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/PlainMessageBody.java @@ -5,13 +5,23 @@ import lombok.EqualsAndHashCode; import lombok.ToString; import net.md_5.bungee.api.chat.BaseComponent; +/** + * Represents a dialog body which consists of text constrained to a certain + * width. + */ @Data @ToString(callSuper = true) @EqualsAndHashCode(callSuper = true) public class PlainMessageBody extends DialogBody { + /** + * The text body. + */ private BaseComponent contents; + /** + * The maximum width (default: 200). + */ private int width; public PlainMessageBody(BaseComponent contents) diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/body/package-info.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/package-info.java new file mode 100644 index 00000000..c2d1a6da --- /dev/null +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/body/package-info.java @@ -0,0 +1,5 @@ +/** + * Contains the different {@link net.md_5.bungee.api.dialog.Dialog} body content + * types. + */ +package net.md_5.bungee.api.dialog.body; diff --git a/dialog/src/main/java/net/md_5/bungee/api/dialog/package-info.java b/dialog/src/main/java/net/md_5/bungee/api/dialog/package-info.java index de66c5a8..474fa929 100644 --- a/dialog/src/main/java/net/md_5/bungee/api/dialog/package-info.java +++ b/dialog/src/main/java/net/md_5/bungee/api/dialog/package-info.java @@ -1,4 +1,4 @@ /** - * Contains the core classes for the display of a {@link Dialog}. + * Contains the core classes for the display of a {@link net.md_5.bungee.api.dialog.Dialog}. */ package net.md_5.bungee.api.dialog;