Package de.gebit.integrity.fixtures

Class CustomProposalProvider.CustomProposalDefinition

java.lang.Object

de.gebit.integrity.fixtures.CustomProposalProvider.CustomProposalDefinition

Enclosing interface:

CustomProposalProvider

public static class CustomProposalProvider.CustomProposalDefinition
extends Object

A container for the definition of one proposal.

Author:

Rene Schneider - initial API and implementation

Constructor Summary

Constructors

Constructor	Description
CustomProposalDefinition(String aValue, String aDisplayValue, Integer aPriority, Boolean aDoPrefixFilteringFlag)	Creates a new instance.
CustomProposalDefinition(String aValue, String aDisplayValue, String anHTMLDescription, String aPlainDescription, Integer aPriority, Boolean aDoPrefixFilteringFlag)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDisplayValue()
boolean	getDoPrefixFiltering()
String	getHtmlDescription()
String	getPlainDescription()
int	getPriority()
String	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomProposalDefinition

public CustomProposalDefinition(String aValue,
                                String aDisplayValue,
                                String anHTMLDescription,
                                String aPlainDescription,
                                Integer aPriority,
                                Boolean aDoPrefixFilteringFlag)

Creates a new instance.

Parameters:

aValue - The actual value that will be inserted when the user accepts the proposal

aDisplayValue - The value displayed to the user in the proposal list. Is optional; if not present, the value from value is used.

anHTMLDescription - The longer HTML description / help text which will appear in the content assist window. This is entirely optional.

aPlainDescription - The longer plaintext description / help text which will appear in the content assist window. This is entirely optional.

aDoPrefixFilteringFlag - Whether this proposal shall be subject to prefix filtering (uses the value and the input from the user to filter non-matching proposals out, like when the user typed "gr", the proposal "great" would be valid, but "bad" wouldn't). Defaults to true.

CustomProposalDefinition

public CustomProposalDefinition(String aValue,
                                String aDisplayValue,
                                Integer aPriority,
                                Boolean aDoPrefixFilteringFlag)

Creates a new instance.

Parameters:

aValue - The actual value that will be inserted when the user accepts the proposal

aDisplayValue - The value displayed to the user in the proposal list. Is optional; if not present, the value from value is used.

aDoPrefixFilteringFlag - Whether this proposal shall be subject to prefix filtering (uses the value and the input from the user to filter non-matching proposals out, like when the user typed "gr", the proposal "great" would be valid, but "bad" wouldn't). Defaults to true.

Method Detail

getValue

public String getValue()

getDisplayValue

public String getDisplayValue()

getHtmlDescription

public String getHtmlDescription()

getPlainDescription

public String getPlainDescription()

getPriority

public int getPriority()

getDoPrefixFiltering

public boolean getDoPrefixFiltering()