Extends example with Sitemesh 3 to support multiple decorators

apache · Nov 15, 2024 · 57a6130 · 57a6130
1 parent f6dcf44
commit 57a6130
Show file tree

Hide file tree

Showing 13 changed files with 148 additions and 36 deletions.
diff --git a/sitemesh3/pom.xml b/sitemesh3/pom.xml
@@ -13,6 +13,10 @@
 
     <packaging>war</packaging>
 
+    <properties>
+        <struts2.version>7.0.0-M11-SNAPSHOT</struts2.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>org.sitemesh</groupId>

diff --git a/sitemesh3/src/main/java/org/apache/struts/examples/sitemesh3/HelloAction.java b/sitemesh3/src/main/java/org/apache/struts/examples/sitemesh3/HelloAction.java
@@ -0,0 +1,43 @@
+package org.apache.struts.examples.sitemesh3;
+
+import org.apache.struts2.ActionSupport;
+import org.apache.struts2.interceptor.parameter.StrutsParameter;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.TreeMap;
+
+public class HelloAction extends ActionSupport {
+
+    private static final Map<String, String> DECORATORS = Collections.unmodifiableSortedMap(new TreeMap<>() {{
+        put("1", "Decorator 1");
+        put("2", "Decorator 2");
+        put("3", "Exclude from decorating");
+    }});
+
+    private String decorator;
+
+    @Override
+    public String execute() throws Exception {
+        if ("1".equals(decorator)) {
+            return SUCCESS;
+        } else if ("2".equals(decorator)) {
+            return "other";
+        }
+        addActionError("Wrong decorator: " + decorator);
+        return ERROR;
+    }
+
+    public String getDecorator() {
+        return decorator;
+    }
+
+    @StrutsParameter
+    public void setDecorator(String decorator) {
+        this.decorator = decorator;
+    }
+
+    public Map<String, String> getDecorators() {
+        return DECORATORS;
+    }
+}
diff --git a/sitemesh3/src/main/resources/struts.xml b/sitemesh3/src/main/resources/struts.xml
@@ -4,19 +4,21 @@
         "https://struts.apache.org/dtds/struts-6.0.dtd">
 <struts>
     <constant name="struts.devMode" value="true"/>
+    <constant name="struts.ui.theme" value="simple"/>
+    <constant name="struts.action.extension" value=""/>
     <constant name="struts.custom.i18n.resources" value="DefaultMessages"/>
 
     <package name="default" extends="struts-default">
         <default-action-ref name="index"/>
         <action name="index">
-            <result type="redirectAction">
-                <param name="actionName">hello</param>
-            </result>
+            <result>/WEB-INF/index.jsp</result>
         </action>
 
-      <action name="hello">
-        <result>/WEB-INF/hello.jsp</result>
-      </action>
+        <action name="hello" class="org.apache.struts.examples.sitemesh3.HelloAction">
+            <result name="success">/WEB-INF/hello1.jsp</result>
+            <result name="other">/WEB-INF/hello2.jsp</result>
+            <result name="error">/WEB-INF/error.jsp</result>
+        </action>
 
     </package>
 </struts>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator.html b/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator.html
@@ -4,6 +4,7 @@
     <sitemesh:write property="head"/>
 </head>
 <body>
+<h1>Default Decorator</h1>
 <sitemesh:write property="body"/>
 </body>
-</html>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator1.html b/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator1.html
@@ -0,0 +1,10 @@
+<html>
+<head>
+    <title><sitemesh:write property="title"/></title>
+    <sitemesh:write property="head"/>
+</head>
+<body>
+<h1>Decorator 1</h1>
+<sitemesh:write property="body"/>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator2.html b/sitemesh3/src/main/webapp/WEB-INF/decorators/decorator2.html
@@ -0,0 +1,10 @@
+<html>
+<head>
+    <title><sitemesh:write property="title"/></title>
+    <sitemesh:write property="head"/>
+</head>
+<body>
+<h1>Decorator 2</h1>
+<sitemesh:write property="body"/>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/error.jsp b/sitemesh3/src/main/webapp/WEB-INF/error.jsp
@@ -0,0 +1,16 @@
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ taglib prefix="s" uri="/struts-tags" %>
+<html>
+<head>
+    <title>SiteMesh example: error</title>
+</head>
+<body>
+<h2>SiteMesh example: error</h2>
+<s:actionerror/>
+
+<s:url var="url" action="hello">
+    <s:param name="decorator" value="1"/>
+</s:url>
+<s:a href="%{url}">Hello</s:a>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/hello.jsp b/sitemesh3/src/main/webapp/WEB-INF/hello.jsp
diff --git a/sitemesh3/src/main/webapp/WEB-INF/hello1.jsp b/sitemesh3/src/main/webapp/WEB-INF/hello1.jsp
@@ -0,0 +1,18 @@
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ taglib prefix="s" uri="/struts-tags" %>
+<html>
+<head>
+    <title>SiteMesh example: Hello 1 with Decorator 1</title>
+</head>
+<body>
+<h2>SiteMesh example: Hello 1 with Decorator 1</h2>
+<h3>Decorators</h3>
+<div>
+    <s:form action="hello" method="get">
+        <s:select name="decorator" list="decorators"/>
+        <s:submit value="Decorate"/>
+    </s:form>
+</div>
+<p>Selected decorator: <s:property value="decorator"/></p>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/hello2.jsp b/sitemesh3/src/main/webapp/WEB-INF/hello2.jsp
@@ -0,0 +1,18 @@
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ taglib prefix="s" uri="/struts-tags" %>
+<html>
+<head>
+    <title>SiteMesh example: Hello 2 with Decorator 2</title>
+</head>
+<body>
+<h2>SiteMesh example: Hello 2 with Decorator 2</h1>
+<h3>Decorators</h3>
+<div>
+    <s:form action="hello" method="get">
+        <s:select name="decorator" list="decorators"/>
+        <s:submit value="Decorate"/>
+    </s:form>
+</div>
+<p>Selected decorator: <s:property value="decorator"/></p>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/index.jsp b/sitemesh3/src/main/webapp/WEB-INF/index.jsp
@@ -0,0 +1,14 @@
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ taglib prefix="s" uri="/struts-tags" %>
+<html>
+<head>
+    <title>SiteMesh example: Index</title>
+</head>
+<body>
+<h2>SiteMesh example: Index with Default Decorator</h2>
+<s:url var="url" action="hello">
+    <s:param name="decorator" value="1"/>
+</s:url>
+<s:a href="%{url}">Hello</s:a>
+</body>
+</html>
diff --git a/sitemesh3/src/main/webapp/WEB-INF/sitemesh3.xml b/sitemesh3/src/main/webapp/WEB-INF/sitemesh3.xml
@@ -1,3 +1,6 @@
 <sitemesh>
     <mapping path="/*" decorator="decorator.html"/>
-</sitemesh>
+    <mapping path="/WEB-INF/error.jsp" exclude="true"/>
+    <mapping path="/WEB-INF/hello1.jsp" decorator="decorator1.html"/>
+    <mapping path="/WEB-INF/hello2.jsp" decorator="decorator2.html"/>
+</sitemesh>
diff --git a/sitemesh3/src/main/webapp/index.html b/sitemesh3/src/main/webapp/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html>
 <head>
-    <META HTTP-EQUIV="Refresh" CONTENT="0;URL=example/HelloWorld.action">
+    <META HTTP-EQUIV="Refresh" CONTENT="0;URL=index.action">
 </head>
 
 <body>