org.hkijena.jipipe.plugins.parameters.library.primitives

Class NumberRangeParameterGenerator

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.parameters.DefaultJIPipeParameterGenerator

org.hkijena.jipipe.plugins.parameters.library.primitives.NumberRangeParameterGenerator

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeParameterGenerator, JIPipeValidatable

public class NumberRangeParameterGenerator
extends DefaultJIPipeParameterGenerator

Generator that creates instances of Number. This cannot be used directly in JIPipeParameterTypeRegistry, as the constructor does not match. You have to inherit from this type and define the number type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
NumberRangeParameterGenerator()

Method Summary

Modifier and Type	Method and Description
<T> List<T>	generateAfterDialog(JIPipeWorkbench workbench, Component parent, Class<T> klass) This function generates the values after the dialog was confirmed
String	getDescription()
double	getMaxNumber()
double	getMinNumber()
String	getName()
double	getStepSize()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setMaxNumber(double maxNumber)
void	setMinNumber(double minNumber)
void	setStepSize(double stepSize)

Methods inherited from class org.hkijena.jipipe.api.parameters.DefaultJIPipeParameterGenerator

generate

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

NumberRangeParameterGenerator

public NumberRangeParameterGenerator()

Method Detail

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class DefaultJIPipeParameterGenerator

Parameters:

reportContext - the report context

report - the report to be added to

generateAfterDialog

public <T> List<T> generateAfterDialog(JIPipeWorkbench workbench,
                                       Component parent,
                                       Class<T> klass)

Description copied from class: DefaultJIPipeParameterGenerator

This function generates the values after the dialog was confirmed

Specified by:

generateAfterDialog in class DefaultJIPipeParameterGenerator

Type Parameters:

T - the generated class

parent - the parent

Returns:

the list of generated objects

getMinNumber

public double getMinNumber()

setMinNumber

public void setMinNumber(double minNumber)

getMaxNumber

public double getMaxNumber()

setMaxNumber

public void setMaxNumber(double maxNumber)

getStepSize

public double getStepSize()

setStepSize

public void setStepSize(double stepSize)

getName

public String getName()

Returns:

name displayed in the menu

getDescription

public String getDescription()

Returns:

description displayed in the menu