com.xmlmind.xmleditext.dita

Class KeyrefChoicesFactory.KeyrefChoices

java.lang.Object

com.xmlmind.xmleditext.dita.KeyrefChoicesFactory.KeyrefChoices

All Implemented Interfaces:

AutoCompletion.Choices, AutoCompletion.SlowChoices

Enclosing class:

KeyrefChoicesFactory

public static final class KeyrefChoicesFactory.KeyrefChoices
extends Object
implements AutoCompletion.SlowChoices

Constructor Summary

Constructors

Constructor and Description
KeyrefChoices(Document document, URL docURL, KeyDefinitions keyDefs, Element keyContext)

Method Summary

Modifier and Type	Method and Description
boolean	choiceListDependsOnPrefix() Returns true if the number of items contained in the AutoCompletion.ChoiceList updated by AutoCompletion.Choices.getChoices(java.lang.String, com.xmlmind.guiutil.AutoCompletion.ChoiceList) depends on the ``prefix'' typed by the user in the text field.
void	getChoices(String prefix, AutoCompletion.ChoiceList choiceList) Computes the list of all possible choices given the ``prefix'' typed by the user.
void	getChoices(String prefix, AutoCompletion.ChoiceList choiceList, ProgressMonitor progressMonitor) Similar to AutoCompletion.Choices, but the computation of the AutoCompletion.ChoiceList is slow and as such, may invoke a ProgressMonitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyrefChoices

public KeyrefChoices(Document document,
                     URL docURL,
                     KeyDefinitions keyDefs,
                     Element keyContext)

Method Detail

choiceListDependsOnPrefix

public boolean choiceListDependsOnPrefix()

Description copied from interface: AutoCompletion.Choices

Returns true if the number of items contained in the AutoCompletion.ChoiceList updated by AutoCompletion.Choices.getChoices(java.lang.String, com.xmlmind.guiutil.AutoCompletion.ChoiceList) depends on the ``prefix'' typed by the user in the text field. Returns false if AutoCompletion.ChoiceList always contains the same number of items. In such case, it's only the value of AutoCompletion.ChoiceList.first which depends on the ``prefix'' typed by the user.

Specified by:

choiceListDependsOnPrefix in interface AutoCompletion.Choices

getChoices

public void getChoices(String prefix,
                       AutoCompletion.ChoiceList choiceList)

Description copied from interface: AutoCompletion.Choices

Computes the list of all possible choices given the ``prefix'' typed by the user.

Specified by:

getChoices in interface AutoCompletion.Choices

Parameters:

prefix - what has been typed in the text field by the user

choiceList - the corresponding list of choices

getChoices

public void getChoices(String prefix,
                       AutoCompletion.ChoiceList choiceList,
                       ProgressMonitor progressMonitor)

Description copied from interface: AutoCompletion.SlowChoices

Similar to AutoCompletion.Choices, but the computation of the AutoCompletion.ChoiceList is slow and as such, may invoke a ProgressMonitor.

Specified by:

getChoices in interface AutoCompletion.SlowChoices

Parameters:

prefix - what has been typed in the text field by the user

choiceList - the corresponding list of choices

progressMonitor - monitor which may be invoked by this implementation. May be null.