de.uka.ilkd.key.strategy.definition

Class OneOfStrategyPropertyDefinition

java.lang.Object

de.uka.ilkd.key.strategy.definition.AbstractStrategyPropertyDefinition

de.uka.ilkd.key.strategy.definition.OneOfStrategyPropertyDefinition

public class OneOfStrategyPropertyDefinition
extends AbstractStrategyPropertyDefinition

Defines that a user interface control which edits a single key-value-pair of the StrategyProperties allows the user to select predefined values. It might be realized via radio buttons or read-only drop down boxes (combos).

Author:

Martin Hentschel

See Also:

AbstractStrategyPropertyDefinition, StrategyPropertyValueDefinition

Field Summary

Fields

Modifier and Type	Field and Description
private int	columnsPerRow Defines optionally how many columns are shown per row.
private ImmutableArray<StrategyPropertyValueDefinition>	values The possible StrategyPropertyValueDefinition which the user can select.

Constructor Summary

Constructors

Constructor and Description
OneOfStrategyPropertyDefinition(java.lang.String apiKey, java.lang.String name, AbstractStrategyPropertyDefinition[] subProperties, StrategyPropertyValueDefinition... values) Constructor.
OneOfStrategyPropertyDefinition(java.lang.String apiKey, java.lang.String name, int columnsPerRow, StrategyPropertyValueDefinition... values) Constructor.
OneOfStrategyPropertyDefinition(java.lang.String apiKey, java.lang.String name, StrategyPropertyValueDefinition... values) Constructor.
OneOfStrategyPropertyDefinition(java.lang.String apiKey, java.lang.String name, java.lang.String tooltip, int columnsPerRow, AbstractStrategyPropertyDefinition[] subProperties, StrategyPropertyValueDefinition... values) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getColumnsPerRow() Returns the maximal columns per row.
ImmutableArray<StrategyPropertyValueDefinition>	getValues() Returns The possible StrategyPropertyValueDefinition which the user can select.

Methods inherited from class de.uka.ilkd.key.strategy.definition.AbstractStrategyPropertyDefinition

getApiKey, getName, getSubProperties, getTooltip

Methods inherited from class java.lang.Object

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

Field Detail

values

private final ImmutableArray<StrategyPropertyValueDefinition> values

The possible StrategyPropertyValueDefinition which the user can select.

columnsPerRow

private final int columnsPerRow

Defines optionally how many columns are shown per row. A negative value means unlimited columns.

Constructor Detail

OneOfStrategyPropertyDefinition

public OneOfStrategyPropertyDefinition(java.lang.String apiKey,
                                       java.lang.String name,
                                       StrategyPropertyValueDefinition... values)

Constructor.

Parameters:

apiKey - The key used in KeY's API.

name - The human readable name of the property.

values - The possible StrategyPropertyValueDefinition which the user can select.

OneOfStrategyPropertyDefinition

public OneOfStrategyPropertyDefinition(java.lang.String apiKey,
                                       java.lang.String name,
                                       int columnsPerRow,
                                       StrategyPropertyValueDefinition... values)

Constructor.

Parameters:

apiKey - The key used in KeY's API.

name - The human readable name of the property.

columnsPerRow - Defines optionally how many columns are shown per row.

values - The possible StrategyPropertyValueDefinition which the user can select.

OneOfStrategyPropertyDefinition

public OneOfStrategyPropertyDefinition(java.lang.String apiKey,
                                       java.lang.String name,
                                       AbstractStrategyPropertyDefinition[] subProperties,
                                       StrategyPropertyValueDefinition... values)

Constructor.

Parameters:

apiKey - The key used in KeY's API.

name - The human readable name of the property.

subProperties - Optional children which edits related properties to this.

values - The possible StrategyPropertyValueDefinition which the user can select.

OneOfStrategyPropertyDefinition

public OneOfStrategyPropertyDefinition(java.lang.String apiKey,
                                       java.lang.String name,
                                       java.lang.String tooltip,
                                       int columnsPerRow,
                                       AbstractStrategyPropertyDefinition[] subProperties,
                                       StrategyPropertyValueDefinition... values)

Constructor.

Parameters:

apiKey - The key used in KeY's API.

name - The human readable name of the property.

tooltip - The optional tooltip text which describes this property.

columnsPerRow - Defines optionally how many columns are shown per row.

subProperties - Optional children which edits related properties to this.

values - The possible StrategyPropertyValueDefinition which the user can select.

Method Detail

getValues

public ImmutableArray<StrategyPropertyValueDefinition> getValues()

Returns The possible StrategyPropertyValueDefinition which the user can select.

Returns:

The possible StrategyPropertyValueDefinition which the user can select.

getColumnsPerRow

public int getColumnsPerRow()

Returns the maximal columns per row.

Returns:

The maximal columns per row or a negative value for unlimited columns.