You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/01/21 16:09:26 UTC
[isis] 01/11: ISIS-2267: adds some further docs for cfg props
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 40d995569d1b18006d5fd6cbbc4c44a87464de0d
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 20 23:52:50 2020 +0000
ISIS-2267: adds some further docs for cfg props
---
.../apache/isis/core/config/IsisConfiguration.java | 50 ++++++++++++++++++----
.../wicket/model/isis/WicketViewerSettings.java | 3 ++
.../services/WicketViewerSettingsDefault.java | 4 ++
3 files changed, 48 insertions(+), 9 deletions(-)
diff --git a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
index 63385a7..91bd5ac 100644
--- a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
+++ b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
@@ -2231,33 +2231,51 @@ public class IsisConfiguration {
* Whether to suppress the sign-up link on the sign-in page.
*
* <p>
- * Although this is disabled by default (in other words the sign-up link is not suppressed), not that
+ * Although this is disabled by default (in other words the sign-up link is not suppressed), note that
* in addition the application must provide an implementation of the
* {@link org.apache.isis.applib.services.userreg.UserRegistrationService} as well as a
- * configured {@link org.apache.isis.applib.services.userreg.EmailNotificationService}.
+ * configured {@link org.apache.isis.applib.services.userreg.EmailNotificationService} (same conditions
+ * as for the {@link #isSuppressPasswordReset()} password reset link).
* </p>
*/
private boolean suppressSignUp = false;
+ /**
+ * Whether to suppress the password reset link on the sign-in page.
+ *
+ * <p>
+ * Although this is disabled by default (in other words the 'reset password' link is not suppressed),
+ * note that in addition the application must provide an implementation of the
+ * {@link org.apache.isis.applib.services.userreg.UserRegistrationService} as well as a
+ * configured {@link org.apache.isis.applib.services.userreg.EmailNotificationService} (same conditions
+ * as for the {@link #isSuppressSignUp()} sign-up link).
+ * </p>
+ */
private boolean suppressPasswordReset = false;
/**
- * The pattern used for rendering and parsing timestamps.
+ * @deprecated - seemingly unused
*/
+ @Deprecated
@NotNull @NotEmpty
private String timestampPattern = "yyyy-MM-dd HH:mm:ss.SSS";
/**
* Whether to show an indicator for a form submit button that it has been clicked.
*
- * This behaviour is enabled by default, but can be disabled using this flag.
+ * <p>
+ * This behaviour is enabled by default.
+ * </p>
*/
private boolean useIndicatorForFormSubmit = true;
+
/**
* Whether to show an indicator for a no-arg action button that it has been clicked.
*
- * This behaviour is enabled by default, but can be disabled using this flag.
+ * <p>
+ * This behaviour is enabled by default.
+ * </p>
*/
private boolean useIndicatorForNoArgAction = true;
@@ -2265,7 +2283,8 @@ public class IsisConfiguration {
* Whether the Wicket source plugin should be enabled; if so, the markup includes links to the Wicket source.
*
* <p>
- * Be aware that this can substantially impact performance.
+ * This behaviour is disabled by default. Please be aware that enabloing it can substantially impact
+ * performance.
* </p>
*/
private boolean wicketSourcePlugin = false;
@@ -2300,8 +2319,13 @@ public class IsisConfiguration {
private String brandLogoSignin;
/**
- * URL of file to read any custom CSS, relative to relative to the class-path resource
- * root.
+ * URL of file to read any custom CSS, relative to <code>static</code> package on the class path.
+ *
+ * <p>
+ * A typical value is <code>css/application.css</code>. This will result in this file being read
+ * from the <code>static.css</code> package (because static resources such as CSS are mounted by
+ * Spring by default under <code>static</code> package).
+ * </p>
*/
private String css;
@@ -2312,7 +2336,15 @@ public class IsisConfiguration {
private String faviconUrl;
/**
- * URL of file to read any custom Javascript, relative to the class-path resource root.
+ */
+ /**
+ * URL of file to read any custom Javascript, relative to <code>static</code> package on the class path.
+ *
+ * <p>
+ * A typical value is <code>css/application.js</code>. This will result in this file being read
+ * from the <code>static.js</code> package (because static resources such as CSS are mounted by
+ * Spring by default under <code>static</code> package).
+ * </p>
*/
private String js;
diff --git a/viewers/wicket/model/src/main/java/org/apache/isis/viewer/wicket/model/isis/WicketViewerSettings.java b/viewers/wicket/model/src/main/java/org/apache/isis/viewer/wicket/model/isis/WicketViewerSettings.java
index 57d6b27..6038027 100644
--- a/viewers/wicket/model/src/main/java/org/apache/isis/viewer/wicket/model/isis/WicketViewerSettings.java
+++ b/viewers/wicket/model/src/main/java/org/apache/isis/viewer/wicket/model/isis/WicketViewerSettings.java
@@ -51,7 +51,10 @@ public interface WicketViewerSettings extends Serializable {
/**
* As per {@link IsisConfiguration.Viewer.Wicket#setTimestampPattern(String)}
+ *
+ * @deprecated - seemingly unused
*/
+ @Deprecated
String getTimestampPattern();
/**
diff --git a/viewers/wicket/viewer/src/main/java/org/apache/isis/viewer/wicket/viewer/services/WicketViewerSettingsDefault.java b/viewers/wicket/viewer/src/main/java/org/apache/isis/viewer/wicket/viewer/services/WicketViewerSettingsDefault.java
index 8666f60..919435c 100644
--- a/viewers/wicket/viewer/src/main/java/org/apache/isis/viewer/wicket/viewer/services/WicketViewerSettingsDefault.java
+++ b/viewers/wicket/viewer/src/main/java/org/apache/isis/viewer/wicket/viewer/services/WicketViewerSettingsDefault.java
@@ -72,6 +72,10 @@ public class WicketViewerSettingsDefault implements WicketViewerSettings {
return getConfiguration().getViewer().getWicket().getDateTimePattern();
}
+ /**
+ * @deprecated - seemingly unused.
+ */
+ @Deprecated
@Override
public String getTimestampPattern() {
return getConfiguration().getViewer().getWicket().getTimestampPattern();