| career | drupal | java | mac | mysql | perl | scala | uml | unix  

JMeter example source code file (

This example JMeter source code file ( is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - JMeter tags/keywords

awt, borderlayout, borderlayout, foreachcontroller, foreachcontroller, foreachcontrolpanel, gui, jlabel, jpanel, jpanel, jtextfield, non-nls-1, non-nls-1, override, string, swing, verticalpanel

The JMeter source code

 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.

package org.apache.jmeter.control.gui;

import java.awt.BorderLayout;

import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;

import org.apache.jmeter.control.ForeachController;
import org.apache.jmeter.gui.util.VerticalPanel;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.util.JMeterUtils;

 * The user interface for a foreach controller which specifies that its
 * subcomponents should be executed some number of times in a loop. This
 * component can be used standalone or embedded into some other component.

public class ForeachControlPanel extends AbstractControllerGui {

    private static final long serialVersionUID = 240L;

     * A field allowing the user to specify the input variable the controller
     * should loop.
    private JTextField inputVal;

     * A field allowing the user to specify output variable the controller
     * should return.
    private JTextField returnVal;

    // Should we add the "_" separator?
    private JCheckBox useSeparator;

     * Boolean indicating whether or not this component should display its name.
     * If true, this is a standalone component. If false, this component is
     * intended to be used as a subpanel for another component.
    private boolean displayName = true;

    /** The name of the infinite checkbox component. */
    private static final String INPUTVAL = "Input Field"; // $NON-NLS-1$

    /** The name of the loops field component. */
    private static final String RETURNVAL = "Return Field"; // $NON-NLS-1$

     * Create a new LoopControlPanel as a standalone component.
    public ForeachControlPanel() {

     * Create a new LoopControlPanel as either a standalone or an embedded
     * component.
     * @param displayName
     *            indicates whether or not this component should display its
     *            name. If true, this is a standalone component. If false, this
     *            component is intended to be used as a subpanel for another
     *            component.
    public ForeachControlPanel(boolean displayName) {
        this.displayName = displayName;

     * A newly created component can be initialized with the contents of a Test
     * Element object by calling this method. The component is responsible for
     * querying the Test Element object for the relevant information to display
     * in its GUI.
     * @param element
     *            the TestElement to configure
    public void configure(TestElement element) {
        inputVal.setText(((ForeachController) element).getInputValString());
        returnVal.setText(((ForeachController) element).getReturnValString());
        useSeparator.setSelected(((ForeachController) element).getUseSeparator());

    /* Implements JMeterGUIComponent.createTestElement() */
    public TestElement createTestElement() {
        ForeachController lc = new ForeachController();
        return lc;

    /* Implements JMeterGUIComponent.modifyTestElement(TestElement) */
    public void modifyTestElement(TestElement lc) {
        if (lc instanceof ForeachController) {
            if (inputVal.getText().length() > 0) {
                ((ForeachController) lc).setInputVal(inputVal.getText());
            } else {
                ((ForeachController) lc).setInputVal(""); // $NON-NLS-1$
            if (returnVal.getText().length() > 0) {
                ((ForeachController) lc).setReturnVal(returnVal.getText());
            } else {
                ((ForeachController) lc).setReturnVal(""); // $NON-NLS-1$
            ((ForeachController) lc).setUseSeparator(useSeparator.isSelected());

     * Implements JMeterGUIComponent.clearGui
    public void clearGui() {

        inputVal.setText(""); // $NON-NLS-1$
        returnVal.setText(""); // $NON-NLS-1$

    public String getLabelResource() {
        return "foreach_controller_title"; // $NON-NLS-1$

     * Initialize the GUI components and layout for this component.
    private void init() {
        // The Loop Controller panel can be displayed standalone or inside
        // another panel. For standalone, we want to display the TITLE, NAME,
        // etc. (everything). However, if we want to display it within another
        // panel, we just display the Loop Count fields (not the TITLE and
        // NAME).

        // Standalone
        if (displayName) {
            setLayout(new BorderLayout(0, 5));
            add(makeTitlePanel(), BorderLayout.NORTH);

            JPanel mainPanel = new JPanel(new BorderLayout());
            mainPanel.add(createLoopCountPanel(), BorderLayout.NORTH);
            add(mainPanel, BorderLayout.CENTER);
        } else {
            // Embedded
            setLayout(new BorderLayout());
            add(createLoopCountPanel(), BorderLayout.NORTH);

     * Create a GUI panel containing the components related to the number of
     * loops which should be executed.
     * @return a GUI panel containing the loop count components
    private JPanel createLoopCountPanel() {
        // JPanel loopPanel = new JPanel(new BorderLayout(5, 0));
        VerticalPanel loopPanel = new VerticalPanel();

        // LOOP LABEL
        JLabel inputValLabel = new JLabel(JMeterUtils.getResString("foreach_input")); // $NON-NLS-1$
        JLabel returnValLabel = new JLabel(JMeterUtils.getResString("foreach_output")); // $NON-NLS-1$

        // TEXT FIELD
        JPanel inputValSubPanel = new JPanel(new BorderLayout(5, 0));
        inputVal = new JTextField("", 5); // $NON-NLS-1$
        inputValSubPanel.add(inputValLabel, BorderLayout.WEST);
        inputValSubPanel.add(inputVal, BorderLayout.CENTER);

        // TEXT FIELD
        JPanel returnValSubPanel = new JPanel(new BorderLayout(5, 0));
        returnVal = new JTextField("", 5); // $NON-NLS-1$
        returnValSubPanel.add(returnValLabel, BorderLayout.WEST);
        returnValSubPanel.add(returnVal, BorderLayout.CENTER);

        // Checkbox
        useSeparator = new JCheckBox(JMeterUtils.getResString("foreach_use_separator"), true); // $NON-NLS-1$


        return loopPanel;

Other JMeter examples (source code examples)

Here is a short list of links related to this JMeter source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.