You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by hn...@apache.org on 2023/02/25 14:24:03 UTC
[myfaces-tobago] branch tobago-5.x updated: doc: markup
This is an automated email from the ASF dual-hosted git repository.
hnoeth pushed a commit to branch tobago-5.x
in repository https://gitbox.apache.org/repos/asf/myfaces-tobago.git
The following commit(s) were added to refs/heads/tobago-5.x by this push:
new 55b99676b2 doc: markup
55b99676b2 is described below
commit 55b99676b2d633ec18b743b75857132a4da593ed
Author: Henning Noeth <hn...@apache.org>
AuthorDate: Sat Feb 25 13:47:32 2023 +0100
doc: markup
* update markup documentation for the taglib
---
.../taglib/component/BarTagDeclaration.java | 4 ++
.../taglib/component/ButtonTagDeclaration.java | 34 +++++++++++-
.../taglib/component/InTagDeclaration.java | 9 +++-
.../taglib/component/LinkTagDeclaration.java | 49 ++++++++++++++++-
.../taglib/component/OutTagDeclaration.java | 61 ++++++++++++++++++++--
.../taglib/component/PopupTagDeclaration.java | 4 ++
6 files changed, 155 insertions(+), 6 deletions(-)
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/BarTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/BarTagDeclaration.java
index 2bfa4dd665..0c00d5bb22 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/BarTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/BarTagDeclaration.java
@@ -74,6 +74,10 @@ import javax.faces.component.UIPanel;
@Markup(
name = org.apache.myfaces.tobago.context.Markup.STRING_EXTRA_LARGE,
description = "Bar collapse at a extra large size."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_TOGGLER_LEFT,
+ description = "Toggler for a collapsed bar is left-aligned."
)
})
public interface BarTagDeclaration
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/ButtonTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/ButtonTagDeclaration.java
index 98034dd584..ada0154988 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/ButtonTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/ButtonTagDeclaration.java
@@ -31,6 +31,7 @@ import org.apache.myfaces.tobago.component.RendererTypes;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasAccessKey;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasAction;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasActionListener;
+import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasConfirmation;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasFragment;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
@@ -41,7 +42,6 @@ import org.apache.myfaces.tobago.internal.taglib.declaration.HasOutcome;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTarget;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
-import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsDefaultCommand;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabledBySecurity;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsImmediateCommand;
@@ -116,6 +116,38 @@ import javax.faces.component.UICommand;
name = org.apache.myfaces.tobago.context.Markup.STRING_DARK,
description = "Set button color to dark color of the theme."
),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_PRIMARY,
+ description = "Set button color to outline primary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_SECONDARY,
+ description = "Set button color to outline secondary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_SUCCESS,
+ description = "Set button color to outline success color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_DANGER,
+ description = "Set button color to outline danger color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_WARNING,
+ description = "Set button color to outline warning color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_INFO,
+ description = "Set button color to outline info color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_LIGHT,
+ description = "Set button color to outline light color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_OUTLINE_DARK,
+ description = "Set button color to outline dark color of the theme."
+ ),
@Markup(
name = org.apache.myfaces.tobago.context.Markup.STRING_NONE,
description = "Colorless button."
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/InTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/InTagDeclaration.java
index d7d0c1a730..1ad287d1e1 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/InTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/InTagDeclaration.java
@@ -22,6 +22,7 @@ package org.apache.myfaces.tobago.internal.taglib.component;
import org.apache.myfaces.tobago.apt.annotation.Behavior;
import org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
import org.apache.myfaces.tobago.apt.annotation.Facet;
+import org.apache.myfaces.tobago.apt.annotation.Markup;
import org.apache.myfaces.tobago.apt.annotation.Tag;
import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
import org.apache.myfaces.tobago.component.ClientBehaviors;
@@ -32,11 +33,11 @@ import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutocomplete;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverter;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverterMessage;
+import org.apache.myfaces.tobago.internal.taglib.declaration.HasDecorationPosition;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasHelp;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelLayout;
-import org.apache.myfaces.tobago.internal.taglib.declaration.HasDecorationPosition;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasPlaceholder;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasRequiredMessage;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
@@ -95,6 +96,12 @@ import javax.faces.component.UIInput;
name = ClientBehaviors.KEYUP),
@Behavior(
name = ClientBehaviors.BLUR)
+ },
+ markups = {
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_NUMBER,
+ description = "Align text to the right."
+ )
})
public interface InTagDeclaration
extends HasIdBindingAndRendered, HasConverter, IsReadonly, IsDisabled, IsRequired, HasHelp, HasTip, IsPassword,
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/LinkTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/LinkTagDeclaration.java
index af3754fe6e..c35e666235 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/LinkTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/LinkTagDeclaration.java
@@ -22,6 +22,7 @@ package org.apache.myfaces.tobago.internal.taglib.component;
import org.apache.myfaces.tobago.apt.annotation.Behavior;
import org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
import org.apache.myfaces.tobago.apt.annotation.Facet;
+import org.apache.myfaces.tobago.apt.annotation.Markup;
import org.apache.myfaces.tobago.apt.annotation.Tag;
import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
import org.apache.myfaces.tobago.component.ClientBehaviors;
@@ -30,6 +31,7 @@ import org.apache.myfaces.tobago.component.RendererTypes;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasAccessKey;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasAction;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasActionListener;
+import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasConfirmation;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasFragment;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
@@ -40,7 +42,6 @@ import org.apache.myfaces.tobago.internal.taglib.declaration.HasOutcome;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTarget;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
-import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabledBySecurity;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsImmediateCommand;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsOmit;
@@ -78,6 +79,52 @@ import javax.faces.component.UICommand;
name = ClientBehaviors.FOCUS),
@Behavior(
name = ClientBehaviors.BLUR)
+ },
+ markups = {
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_PRIMARY,
+ description = "Set text color to primary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_SECONDARY,
+ description = "Set text color to secondary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_SUCCESS,
+ description = "Set text color to success color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_DANGER,
+ description = "Set text color to danger color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_WARNING,
+ description = "Set text color to warning color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_INFO,
+ description = "Set text color to info color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_LIGHT,
+ description = "Set text color to light color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_DARK,
+ description = "Set text color to dark color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_BOLD,
+ description = "Set font to bold."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_THIN,
+ description = "Set font to thin."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_ITALIC,
+ description = "Set font to italic."
+ )
})
public interface LinkTagDeclaration
extends HasIdBindingAndRendered, HasAction, HasActionListener, IsImmediateCommand, HasConfirmation,
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/OutTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/OutTagDeclaration.java
index e54090b302..f6869859a7 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/OutTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/OutTagDeclaration.java
@@ -20,20 +20,21 @@
package org.apache.myfaces.tobago.internal.taglib.component;
import org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
+import org.apache.myfaces.tobago.apt.annotation.Markup;
import org.apache.myfaces.tobago.apt.annotation.Tag;
import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
import org.apache.myfaces.tobago.component.RendererTypes;
+import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverter;
+import org.apache.myfaces.tobago.internal.taglib.declaration.HasDecorationPosition;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelLayout;
-import org.apache.myfaces.tobago.internal.taglib.declaration.HasDecorationPosition;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasSanitize;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
-import org.apache.myfaces.tobago.internal.taglib.declaration.HasAutoSpacing;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsPlain;
import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
@@ -54,7 +55,61 @@ import java.text.MessageFormat;
// As long as no behavior event names are defined, ClientBehaviorHolder must be implemented for Mojarra.
"javax.faces.component.behavior.ClientBehaviorHolder"
},
- allowedChildComponenents = "NONE")
+ allowedChildComponenents = "NONE",
+ markups = {
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_PRIMARY,
+ description = "Set text color to primary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_SECONDARY,
+ description = "Set text color to secondary color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_SUCCESS,
+ description = "Set text color to success color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_DANGER,
+ description = "Set text color to danger color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_WARNING,
+ description = "Set text color to warning color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_INFO,
+ description = "Set text color to info color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_LIGHT,
+ description = "Set text color to light color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_DARK,
+ description = "Set text color to dark color of the theme."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_BOLD,
+ description = "Set font to bold."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_THIN,
+ description = "Set font to thin."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_ITALIC,
+ description = "Set font to italic."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_NUMBER,
+ description = "Align text to the right."
+ ),
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_DELETED,
+ description = "Strike text through."
+ )
+ })
public interface OutTagDeclaration
extends HasIdBindingAndRendered, HasConverter, HasTip, HasValue, IsVisual,
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/PopupTagDeclaration.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/PopupTagDeclaration.java
index d928c5d7bb..a68321dfe0 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/PopupTagDeclaration.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/component/PopupTagDeclaration.java
@@ -45,6 +45,10 @@ import org.apache.myfaces.tobago.model.CollapseMode;
},
rendererType = RendererTypes.POPUP,
markups = {
+ @Markup(
+ name = org.apache.myfaces.tobago.context.Markup.STRING_EXTRA_LARGE,
+ description = "Extra large popup"
+ ),
@Markup(
name = org.apache.myfaces.tobago.context.Markup.STRING_LARGE,
description = "Large popup"