|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.security.auth.callback.ChoiceCallback
public class ChoiceCallback
Underlying security services instantiate and pass a
ChoiceCallback to the handle
method of a CallbackHandler to display a list of choices
and to retrieve the selected choice(s).
CallbackHandler,
Serialized Form| Constructor Summary | |
|---|---|
ChoiceCallback(String prompt,
String[] choices,
int defaultChoice,
boolean multipleSelectionsAllowed)
Construct a ChoiceCallback with a prompt,
a list of choices, a default choice, and a boolean specifying
whether or not multiple selections from the list of choices are allowed. |
|
| Method Summary | |
|---|---|
boolean |
allowMultipleSelections()
Get the boolean determining whether multiple selections from the choices list are allowed. |
String[] |
getChoices()
Get the list of choices. |
int |
getDefaultChoice()
Get the defaultChoice. |
String |
getPrompt()
Get the prompt. |
int[] |
getSelectedIndexes()
Get the selected choices. |
void |
setSelectedIndex(int selection)
Set the selected choice. |
void |
setSelectedIndexes(int[] selections)
Set the selected choices. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ChoiceCallback(String prompt,
String[] choices,
int defaultChoice,
boolean multipleSelectionsAllowed)
ChoiceCallback with a prompt,
a list of choices, a default choice, and a boolean specifying
whether or not multiple selections from the list of choices are allowed.
prompt - the prompt used to describe the list of choices. choices - the list of choices. defaultChoice - the choice to be used as the default choice
when the list of choices are displayed. This value
is represented as an index into the
choices array. multipleSelectionsAllowed - boolean specifying whether or
not multiple selections can be made from the
list of choices.
IllegalArgumentException - if prompt is null,
if prompt has a length of 0,
if choices is null,
if choices has a length of 0,
if any element from choices is null,
if any element from choices
has a length of 0 or if defaultChoice
does not fall within the array boundaries of
choices.| Method Detail |
|---|
public String getPrompt()
public String[] getChoices()
public int getDefaultChoice()
choices list.public boolean allowMultipleSelections()
choices list are allowed.
public void setSelectedIndex(int selection)
selection - the selection represented as an index into the
choices list.getSelectedIndexes()public void setSelectedIndexes(int[] selections)
selections - the selections represented as indexes into the
choices list.
UnsupportedOperationException - if multiple selections are
not allowed, as determined by
allowMultipleSelections.getSelectedIndexes()public int[] getSelectedIndexes()
choices list.setSelectedIndexes(int[])
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.