org.apache.jmeter.config.gui

Class LoginConfigGui

Implemented Interfaces:
JMeterGUIComponent, Printable

public class LoginConfigGui
extends AbstractConfigGui

A GUI component allowing the user to enter a username and password for a login.

Field Summary

Fields inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent

namePanel

Constructor Summary

LoginConfigGui()
Create a new LoginConfigGui as a standalone component.
LoginConfigGui(boolean displayName)
Create a new LoginConfigGui as either a standalone or an embedded component.

Method Summary

void
clearGui()
Implements JMeterGUIComponent.clearGui
void
configure(TestElement element)
A newly created component can be initialized with the contents of a Test Element object by calling this method.
TestElement
createTestElement()
JMeter test components are separated into a model and a GUI representation.
String
getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language.
void
modifyTestElement(TestElement element)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components.

Methods inherited from class org.apache.jmeter.config.gui.AbstractConfigGui

createPopupMenu, getMenuCategories

Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent

clearGui, configure, configureTestElement, createTitleLabel, getComment, getDocAnchor, getName, getNamePanel, getNode, getPrintableComponent, getStaticLabel, isEnabled, makeBorder, makeScrollPane, makeScrollPane, makeTitlePanel, setComment, setEnabled, setName, setNode

Constructor Details

LoginConfigGui

public LoginConfigGui()
Create a new LoginConfigGui as a standalone component.

LoginConfigGui

public LoginConfigGui(boolean displayName)
Create a new LoginConfigGui as either a standalone or an embedded component.
Parameters:
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.

Method Details

clearGui

public void clearGui()
Implements JMeterGUIComponent.clearGui
Specified by:
clearGui in interface JMeterGUIComponent
Overrides:
clearGui in interface AbstractJMeterGuiComponent

configure

public void configure(TestElement element)
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.
Specified by:
configure in interface JMeterGUIComponent
Overrides:
configure in interface AbstractJMeterGuiComponent
Parameters:
element - the TestElement to configure

createTestElement

public TestElement createTestElement()
JMeter test components are separated into a model and a GUI representation. The model holds the data and the GUI displays it. The GUI class is responsible for knowing how to create and initialize with data the model class that it knows how to display, and this method is called when new test elements are created.
Specified by:
createTestElement in interface JMeterGUIComponent
Returns:
the Test Element object that the GUI component represents.

getLabelResource

public String getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language. The resource name is fixed, and does not vary with the selected language. Normally this method should be overriden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.
Specified by:
getLabelResource in interface JMeterGUIComponent
Returns:
the resource name

modifyTestElement

public void modifyTestElement(TestElement element)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. This method should overwrite whatever data is currently in the TestElement as it is called after a user has filled out the form elements in the gui with new information.
Specified by:
modifyTestElement in interface JMeterGUIComponent
Parameters:
element - the TestElement to modify

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.