[Tapestry Wiki] Update of "Tapestry5SubmitContextWithNavigationComponent" by VilleVirtanen

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Tapestry Wiki" for change notification.

The following page has been changed by VilleVirtanen:
http://wiki.apache.org/tapestry/Tapestry5SubmitContextWithNavigationComponent

New page:
Tapestry5SubmitContextWithNavigationComponent

This is especially useful in loops, where the component name is dynamic. This component is based on the Tapestry5SubmitContextComponent from Tapestry 5 how-tos.[[BR]]

To use it, add this to your page template: (Context can be omitted if that functionality is not needed.)
{{{
<input t:type="SubmitContext" t:id="theSubmit" t:context="idString"/>
}}}

add this to your page class:
{{{
Object onSelectedFromTheSubmit(String idString)
{
    // do something based on idString
    return "somePage"; //Navigation allowed using this component!
}
}}}

'''Source:'''[[BR]]
(Modified from T5.0.15. Put it into yourapp.components package.)
{{{
// Copyright 2007 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.some.package.tapestry5.components;

import org.apache.tapestry5.BindingConstants;
import org.apache.tapestry5.ComponentResources;
import org.apache.tapestry5.MarkupWriter;
import org.apache.tapestry5.annotations.Environmental;
import org.apache.tapestry5.annotations.Mixin;
import org.apache.tapestry5.annotations.Parameter;
import org.apache.tapestry5.corelib.base.AbstractField;
import org.apache.tapestry5.corelib.mixins.RenderDisabled;
import org.apache.tapestry5.internal.services.ComponentResultProcessorWrapper;
import org.apache.tapestry5.ioc.annotations.Inject;
import org.apache.tapestry5.services.ComponentEventResultProcessor;
import org.apache.tapestry5.services.FormSupport;
import org.apache.tapestry5.services.Heartbeat;
import org.apache.tapestry5.services.Request;

/**
  * Corresponds to &lt;input type="submit"&gt;, a client-side element that can force the
  * enclosing form to submit. The submit responsible for the form submission will post a
  * notification that allows the application to know that it was the responsible entity. The
  * notification is named "selected" and has a String context.
  */
public final class SubmitContext extends AbstractField {
    
    //FIXME: in 5.0.16-SNAPSHOT This is moved to org.apache.tapestry5.EventConstants -> modify when 5.0.16 is released.
    static final String SELECTED_EVENT = "selected";

    /**
     * If true (the default), then any notification sent by the component will be deferred until the end of the form
     * submission (this is usually desirable).
     */
    @Parameter
    private boolean defer = true;

    /**
     * The name of the event that will be triggered if this component is the cause of the form submission. The default
     * is "selected".
     */
    @Parameter(allowNull = false, defaultPrefix = BindingConstants.LITERAL)
    private String event = SELECTED_EVENT;

    @Environmental
    private FormSupport formSupport;

    @Environmental
    private Heartbeat heartbeat;
    
    @Environmental
    private ComponentEventResultProcessor componentEventResultProcessor;

    @Parameter
    private String context;
    
    @Inject
    private ComponentResources resources;

    @Inject
    private Request request;

    @SuppressWarnings("unused")
    @Mixin
    private RenderDisabled renderDisabled;

    public SubmitContext() {
    }

    SubmitContext(Request request) {
        this.request = request;
    }

    void beginRender(MarkupWriter writer) {
        
        String controlName = getControlName();
        
        // write a hidden input for the context
        if(resources.isBound("context")){
            writer.element("input", "type", "hidden", "name", controlName + "X", "value", context);
            writer.end();
        }
        
        // write submit
        writer.element("input", "type", "submit", "name", controlName, "id", getClientId());
        resources.renderInformalParameters(writer);
    }

    void afterRender(MarkupWriter writer) {
        writer.end();
    }

    @Override
    protected void processSubmission(String elementName) {
        String value = request.getParameter(elementName);
        
        if (value == null) return;

        final String cntxt = request.getParameter(elementName + "X");
        final ComponentResultProcessorWrapper callback = new ComponentResultProcessorWrapper(componentEventResultProcessor);
        
        Runnable sendNotification = new Runnable()
        {
            public void run()
            {
                if(cntxt != null){
                    resources.triggerEvent(event, new Object[] {cntxt}, callback);
                }else{
                    resources.triggerEvent(event, null, callback);
                }
            }
        };

        // When not deferred, don't wait, fire the event now (actually, at the end of the current
        // heartbeat). This is most likely because the Submit is inside a Loop and some contextual
        // information will change if we defer.

        if (defer) formSupport.defer(sendNotification);
        else heartbeat.defer(sendNotification);
    }

    // For testing:

    void setDefer(boolean defer)
    {
        this.defer = defer;
    }

    void setup(ComponentResources resources, FormSupport support, Heartbeat heartbeat)
    {
        this.resources = resources;
        formSupport = support;
        this.heartbeat = heartbeat;
    }
    
}
}}}

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org