Class AbstractJMeterGuiComponent

    • Field Detail

      • namePanel

        protected NamePanel namePanel
        A GUI panel containing the name of this component.
    • Constructor Detail

      • AbstractJMeterGuiComponent

        public AbstractJMeterGuiComponent()
        When constructing a new component, this takes care of basic tasks like setting up the Name Panel and assigning the class's static label as the name to start.
    • Method Detail

      • setName

        public void setName​(String name)
        Provides a default implementation for setting the name property. It's unlikely developers will need to override.
        Specified by:
        setName in interface JMeterGUIComponent
        Overrides:
        setName in class Component
        Parameters:
        name - the name of the component
      • setComment

        public void setComment​(String comment)
        Provides a default implementation for setting the comment property. It's unlikely developers will need to override.
        Parameters:
        comment - The comment for the property
      • isEnabled

        public boolean isEnabled()
        Provides a default implementation for the enabled property. It's unlikely developers will need to override.
        Specified by:
        isEnabled in interface JMeterGUIComponent
        Overrides:
        isEnabled in class Component
        Returns:
        true if the element should be part of the test run, false otherwise
      • setEnabled

        public void setEnabled​(boolean e)
        Provides a default implementation for the enabled property. It's unlikely developers will need to override.
        Specified by:
        setEnabled in interface JMeterGUIComponent
        Overrides:
        setEnabled in class JComponent
        Parameters:
        e - true for enabled, false for disabled.
      • getName

        public String getName()
        Provides a default implementation for the name property. It's unlikely developers will need to override.
        Specified by:
        getName in interface JMeterGUIComponent
        Overrides:
        getName in class Component
        Returns:
        the name of the component
      • getComment

        public String getComment()
        Provides a default implementation for the comment property. It's unlikely developers will need to override.
        Returns:
        The comment for the property
      • getNamePanel

        protected NamePanel getNamePanel()
        Provides the Name Panel for extending classes. Extending classes are free to place it as desired within the component, or not at all. Most components place the NamePanel automatically by calling makeTitlePanel() instead of directly calling this method.
        Returns:
        a NamePanel containing the name of this component
      • createTitleLabel

        protected Component createTitleLabel()
        Provides a label containing the title for the component. Subclasses typically place this label at the top of their GUI. The title is set to the name returned from the component's getStaticLabel() method. Most components place this label automatically by calling makeTitlePanel() instead of directly calling this method.
        Returns:
        a JLabel which subclasses can add to their GUI
      • configure

        public void configure​(TestElement element)
        A newly created gui 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.

        AbstractJMeterGuiComponent provides a partial implementation of this method, setting the name of the component and its enabled status. Subclasses should override this method, performing their own configuration as needed, but also calling this super-implementation.

        Specified by:
        configure in interface JMeterGUIComponent
        Parameters:
        element - the TestElement to configure
      • clearGui

        public void clearGui()
        Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. Your GUI may need more things cleared, in which case you should override, clear the extra fields, and still call super.clearGui().
        Specified by:
        clearGui in interface ClearGui
      • configureTestElement

        protected void configureTestElement​(TestElement mc)
        This provides a convenience for extenders when they implement the JMeterGUIComponent.modifyTestElement(TestElement) method. This method will set the name, gui class, and test class for the created Test Element. It should be called by every extending class when creating/modifying Test Elements, as that will best assure consistent behavior.
        Parameters:
        mc - the TestElement being created.
      • makeTitlePanel

        protected Container makeTitlePanel()
        Create a standard title section for JMeter components. This includes the title for the component and the Name Panel allowing the user to change the name for the component. This method is typically added to the top of the component at the beginning of the component's init method.
        Returns:
        a panel containing the component title and name panel
      • makeBorder

        protected Border makeBorder()
        Create a top-level Border which can be added to JMeter components. Components typically set this as their border in their init method. It simply provides a nice spacing between the GUI components used and the edges of the window in which they appear.
        Returns:
        a Border for JMeter components
      • makeScrollPane

        protected JScrollPane makeScrollPane​(Component comp)
        Create a scroll panel that sets it's preferred size to it's minimum size. Explicitly for scroll panes that live inside other scroll panes, or within containers that stretch components to fill the area they exist in. Use this for any component you would put in a scroll pane (such as TextAreas, tables, JLists, etc). It is here for convenience and to avoid duplicate code. JMeter displays best if you follow this custom.
        Parameters:
        comp - the component which should be placed inside the scroll pane
        Returns:
        a JScrollPane containing the specified component
      • makeScrollPane

        protected JScrollPane makeScrollPane​(Component comp,
                                             int verticalPolicy,
                                             int horizontalPolicy)
        Create a scroll panel that sets it's preferred size to it's minimum size. Explicitly for scroll panes that live inside other scroll panes, or within containers that stretch components to fill the area they exist in. Use this for any component you would put in a scroll pane (such as TextAreas, tables, JLists, etc). It is here for convenience and to avoid duplicate code. JMeter displays best if you follow this custom.
        Parameters:
        comp - the component which should be placed inside the scroll pane
        verticalPolicy - the vertical scroll policy
        horizontalPolicy - the horizontal scroll policy
        Returns:
        a JScrollPane containing the specified component
        See Also:
        ScrollPaneConstants
      • getStaticLabel

        public String getStaticLabel()
        Description copied from interface: JMeterGUIComponent
        Get the component's label. This label is used in drop down lists that give the user the option of choosing one type of component in a list of many. It should therefore be a descriptive name for the end user to see. It must be unique to the class. It is also used by Help to find the appropriate location in the documentation. Normally getLabelResource() should be overridden instead of this method; the definition of this method in AbstractJMeterGuiComponent is intended for general use.
        Specified by:
        getStaticLabel in interface JMeterGUIComponent
        Returns:
        GUI label for the component.
        See Also:
        JMeterGUIComponent.getLabelResource()
      • getDocAnchor

        public String getDocAnchor()
        Compute Anchor value to find reference in documentation for a particular component
        Specified by:
        getDocAnchor in interface JMeterGUIComponent
        Returns:
        String anchor
      • getPrintableComponent

        public JComponent getPrintableComponent()
        Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.
        Specified by:
        getPrintableComponent in interface Printable
        Returns:
        this object