Package com.ptc.core.components.suggest

Class SuggestResult

java.lang.Object

com.ptc.core.components.suggest.SuggestMessage

com.ptc.core.components.suggest.SuggestResult

All Implemented Interfaces:

Serializable

public final class SuggestResult
extends com.ptc.core.components.suggest.SuggestMessage

This represents the result of suggestion search

Supported API: true

Extendable: false

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static SuggestResult	valueOf(String display_text)	Returns a new SuggestResults initialized to the values specified in the parameters.
static SuggestResult	valueOf(String display_text, String additional_text)	Returns a new SuggestResults initialized to the values specified in the parameters.
static SuggestResult	valueOf(String display_text, String additional_text, String value_text)	Returns a new SuggestResults initialized to the values specified in the parameters.
static SuggestResult	valueOfAlt(String display_text, String value_text)	Returns a new SuggestResults initialized to the values specified in the parameters.

Methods inherited from class com.ptc.core.components.suggest.SuggestMessage

getAdditionalText, getDisplayText, getSuggestDisplayText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

valueOf

public static SuggestResult valueOf(String display_text)

Returns a new SuggestResults initialized to the values specified in the parameters. The argument is the text to place in the text field.

Supported API: true

Parameters:

display_text - the displayText of this element

Returns:

a newly constructed SuggestResults initialized to the values specified in the parameters

valueOf

public static SuggestResult valueOf(String display_text,
 String additional_text)

Returns a new SuggestResults initialized to the values specified in the parameters. The first argument is the text to place in the text field, the second is any additional text that should be displayed in the suggest drop down but notactually copied into the text box.

Supported API: true

Parameters:

display_text - the displayText of this element

additional_text - the additionalText of this element

Returns:

a newly constructed SuggestResults initialized to the values specified in the parameters

valueOfAlt

public static SuggestResult valueOfAlt(String display_text,
 String value_text)

Returns a new SuggestResults initialized to the values specified in the parameters. The first argument is the text to place in the text field. The second argument is any string that should be copied to the hidden form field associated with the text box.

Supported API: true

Parameters:

display_text - the displayText of this element

value_text - the valueText of this element

Returns:

a newly constructed SuggestResults initialized to the values specified in the parameters

valueOf

public static SuggestResult valueOf(String display_text,
 String additional_text,
 String value_text)

Returns a new SuggestResults initialized to the values specified in the parameters. The first argument is the text to place in the text field, the second is any additional text that should be displayed in the suggest drop down but notactually copied into the text box. The third argument is any string that should be copied to the hidden form field associated with the text box.

Supported API: true

Parameters:

display_text - the displayText of this element

additional_text - the additionalText of this element

value_text - the valueText of this element

Returns:

a newly constructed SuggestResults initialized to the values specified in the parameters