VariableInputDescriptor (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.util
Class VariableInputDescriptor

java.lang.Object
  org.netbeans.modules.vcscore.util.VariableInputDescriptor

public class VariableInputDescriptor
extends Object

The descriptor of variable input components.

Field Summary

static String DEFAULTS_MODE_EXPERT_USER


static String DEFAULTS_MODE_USER


static String IF_VAR_EMPTY_BEGIN


static String IF_VAR_EMPTY_END


static String IF_VAR_NON_EMPTY_BEGIN


static String IF_VAR_NON_EMPTY_END


static int INPUT_A11Y


static int INPUT_ACCESSIBILITY


static int INPUT_ASK


static int INPUT_AUTOFILL


static int INPUT_COMBO_ITEM


static int INPUT_GLOBAL


static int INPUT_HELP_ID


static String INPUT_IS_EXPERT


static String INPUT_IS_TRIVIAL


static int INPUT_JCOMPONENT


static int INPUT_LABEL


static int INPUT_PROFILE_DEFAULTS


static int INPUT_PROMPT_AREA


static int INPUT_PROMPT_FIELD


static int INPUT_PROMPT_PASSWD


static int INPUT_RADIO_BTN


static int INPUT_SELECT_COMBO


static int INPUT_SELECT_COMBO_EDITABLE


static int INPUT_SELECT_RADIO


static char INPUT_SELECT_STR_ARG_CLOSE


static char INPUT_SELECT_STR_ARG_OPEN


static String INPUT_STR_A11Y


static String INPUT_STR_A11Y_DELIMETER


static String INPUT_STR_A11Y_DESCRIPTION


static String INPUT_STR_A11Y_NAME


static String INPUT_STR_ACCESSIBILITY


static char INPUT_STR_ARG_CLOSE


static char INPUT_STR_ARG_OPEN


static String INPUT_STR_ASK


static String INPUT_STR_AUTOFILL
          The name of the variable, that contains pairs of variables and commands.

static String INPUT_STR_DISABLE


static String INPUT_STR_ENABLE


static String INPUT_STR_GLOBAL_ALL_VARS


static String INPUT_STR_GLOBAL_PARAMS


static String INPUT_STR_HELP_ID


static String INPUT_STR_JCOMPONENT
          The name of statement that points to JComponnet that implements NestableInputComponent.

static String INPUT_STR_LABEL


static String INPUT_STR_MNEMONIC


static String INPUT_STR_PROFILE_DEFAULTS
          The name of statement that contains list of variables which recent value can be stored as profile command default for next time.

static String INPUT_STR_PROMPT_AREA


static String INPUT_STR_PROMPT_FIELD


static String INPUT_STR_PROMPT_PASSWD


static String INPUT_STR_SELECT_COMBO


static String INPUT_STR_SELECT_COMBO_EDITABLE


static String INPUT_STR_SELECT_RADIO


static String INPUT_STR_TEXT


static int INPUT_TEXT


static String SELECTOR


static String SELECTOR_CMD


static String SELECTOR_DATE_CVS


static String SELECTOR_DIR


static String SELECTOR_FILE


static String STYLE


static String STYLE_READ_ONLY


Method Summary

void addValuesToHistory()


VariableInputComponent[] components()
          Get the array of components.

static VariableInputDescriptor create(String label, VariableInputComponent[] components)
          Create a new VariableInputDescriptor.

String getA11yDescription()
          Get the accessibility description of this input descriptor.

String getA11yName()
          Get the accessibility name of this input descriptor.

String getAutoFillVars()
          Get the string representation of the auto fill variables

String getHelpID()
          Get the help ID that should be associated with the dialog.

String getLabel()
          Get the label of this input descriptor.

String getStringInputItems()
          Get the string representation of this VariableInputDescriptor.

boolean hasDefaults(String commandName, String commandProvider, boolean expertMode)
          Tests whether is make ssense to supprot writing dowm default for this descriptor.

void loadDefaults(String commandName, String commandProvider, boolean expertMode)
          Loads default values from disk into component values.

static VariableInputDescriptor parseItems(String inputItems, String[] resourceBundles)
          Parse the string representation of components into the descriptor object.

void setDefaultValues()


void setValuesAsDefault()


void storeDefaults(String commandName, String commandProvider)
          Stores component values to disk default values.

String toString()
          Get the string representation of this VariableInputDescriptor.

VariableInputValidator validate()
          Check, that the values of all nested components are valid.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_LABEL

public static final int INPUT_LABEL

See Also:: Constant Field Values

INPUT_ACCESSIBILITY

public static final int INPUT_ACCESSIBILITY

See Also:: Constant Field Values

INPUT_A11Y

public static final int INPUT_A11Y

See Also:: Constant Field Values

INPUT_PROMPT_FIELD

public static final int INPUT_PROMPT_FIELD

See Also:: Constant Field Values

INPUT_PROMPT_AREA

public static final int INPUT_PROMPT_AREA

See Also:: Constant Field Values

INPUT_PROMPT_PASSWD

public static final int INPUT_PROMPT_PASSWD

See Also:: Constant Field Values

INPUT_ASK

public static final int INPUT_ASK

See Also:: Constant Field Values

INPUT_SELECT_RADIO

public static final int INPUT_SELECT_RADIO

See Also:: Constant Field Values

INPUT_RADIO_BTN

public static final int INPUT_RADIO_BTN

See Also:: Constant Field Values

INPUT_SELECT_COMBO

public static final int INPUT_SELECT_COMBO

See Also:: Constant Field Values

INPUT_COMBO_ITEM

public static final int INPUT_COMBO_ITEM

See Also:: Constant Field Values

INPUT_GLOBAL

public static final int INPUT_GLOBAL

See Also:: Constant Field Values

INPUT_SELECT_COMBO_EDITABLE

public static final int INPUT_SELECT_COMBO_EDITABLE

See Also:: Constant Field Values

INPUT_TEXT

public static final int INPUT_TEXT

See Also:: Constant Field Values

INPUT_HELP_ID

public static final int INPUT_HELP_ID

See Also:: Constant Field Values

INPUT_AUTOFILL

public static final int INPUT_AUTOFILL

See Also:: Constant Field Values

INPUT_PROFILE_DEFAULTS

public static final int INPUT_PROFILE_DEFAULTS

See Also:: Constant Field Values

INPUT_JCOMPONENT

public static final int INPUT_JCOMPONENT

See Also:: Constant Field Values

INPUT_STR_LABEL

public static final String INPUT_STR_LABEL

See Also:: Constant Field Values

INPUT_STR_AUTOFILL

public static final String INPUT_STR_AUTOFILL

The name of the variable, that contains pairs of variables and commands. When the variables listed here change their value, the corresponding command is executed to fill values of remaining variables. This can be used to automatically fill in VCS configuartion, when it can be obtained from local configuration files.

See Also:: Constant Field Values

INPUT_STR_PROFILE_DEFAULTS

public static final String INPUT_STR_PROFILE_DEFAULTS

The name of statement that contains list of variables which recent value can be stored as profile command default for next time. e.g. VARIABLE_DEFAULTS(PRUNE_EMPTY USER, CREATE_DIRS USER). There are couples: viable name and handling type:

USER stores default as user's for both modes
EXPERT_USER stores default as user's for expert mode only

See Also:: Constant Field Values

INPUT_STR_JCOMPONENT

public static final String INPUT_STR_JCOMPONENT

The name of statement that points to JComponnet that implements NestableInputComponent. The syntax is: JCOMPONENT(VARIABLE_NAME, package.className)

See Also:: Constant Field Values

DEFAULTS_MODE_USER

public static final String DEFAULTS_MODE_USER

See Also:: Constant Field Values

DEFAULTS_MODE_EXPERT_USER

public static final String DEFAULTS_MODE_EXPERT_USER

See Also:: Constant Field Values

INPUT_STR_HELP_ID

public static final String INPUT_STR_HELP_ID

See Also:: Constant Field Values

INPUT_STR_PROMPT_FIELD

public static final String INPUT_STR_PROMPT_FIELD

See Also:: Constant Field Values

INPUT_STR_PROMPT_AREA

public static final String INPUT_STR_PROMPT_AREA

See Also:: Constant Field Values

INPUT_STR_PROMPT_PASSWD

public static final String INPUT_STR_PROMPT_PASSWD

See Also:: Constant Field Values

INPUT_STR_ASK

public static final String INPUT_STR_ASK

See Also:: Constant Field Values

INPUT_STR_SELECT_RADIO

public static final String INPUT_STR_SELECT_RADIO

See Also:: Constant Field Values

INPUT_STR_SELECT_COMBO

public static final String INPUT_STR_SELECT_COMBO

See Also:: Constant Field Values

INPUT_STR_SELECT_COMBO_EDITABLE

public static final String INPUT_STR_SELECT_COMBO_EDITABLE

See Also:: Constant Field Values

INPUT_STR_TEXT

public static final String INPUT_STR_TEXT

See Also:: Constant Field Values

INPUT_STR_GLOBAL_PARAMS

public static final String INPUT_STR_GLOBAL_PARAMS

See Also:: Constant Field Values

INPUT_STR_GLOBAL_ALL_VARS

public static final String INPUT_STR_GLOBAL_ALL_VARS

See Also:: Constant Field Values

INPUT_IS_EXPERT

public static final String INPUT_IS_EXPERT

See Also:: Constant Field Values

INPUT_IS_TRIVIAL

public static final String INPUT_IS_TRIVIAL

See Also:: Constant Field Values

INPUT_STR_ENABLE

public static final String INPUT_STR_ENABLE

See Also:: Constant Field Values

INPUT_STR_DISABLE

public static final String INPUT_STR_DISABLE

See Also:: Constant Field Values

INPUT_STR_ACCESSIBILITY

public static final String INPUT_STR_ACCESSIBILITY

See Also:: Constant Field Values

INPUT_STR_A11Y

public static final String INPUT_STR_A11Y

See Also:: Constant Field Values

INPUT_STR_A11Y_NAME

public static final String INPUT_STR_A11Y_NAME

See Also:: Constant Field Values

INPUT_STR_A11Y_DESCRIPTION

public static final String INPUT_STR_A11Y_DESCRIPTION

See Also:: Constant Field Values

INPUT_STR_MNEMONIC

public static final String INPUT_STR_MNEMONIC

See Also:: Constant Field Values

INPUT_STR_A11Y_DELIMETER

public static final String INPUT_STR_A11Y_DELIMETER

See Also:: Constant Field Values

SELECTOR

public static final String SELECTOR

See Also:: Constant Field Values

SELECTOR_FILE

public static final String SELECTOR_FILE

See Also:: Constant Field Values

SELECTOR_DIR

public static final String SELECTOR_DIR

See Also:: Constant Field Values

SELECTOR_DATE_CVS

public static final String SELECTOR_DATE_CVS

See Also:: Constant Field Values

SELECTOR_CMD

public static final String SELECTOR_CMD

See Also:: Constant Field Values

STYLE

public static final String STYLE

See Also:: Constant Field Values

STYLE_READ_ONLY

public static final String STYLE_READ_ONLY

See Also:: Constant Field Values

IF_VAR_NON_EMPTY_BEGIN

public static final String IF_VAR_NON_EMPTY_BEGIN

See Also:: Constant Field Values

IF_VAR_NON_EMPTY_END

public static final String IF_VAR_NON_EMPTY_END

See Also:: Constant Field Values

IF_VAR_EMPTY_BEGIN

public static final String IF_VAR_EMPTY_BEGIN

See Also:: Constant Field Values

IF_VAR_EMPTY_END

public static final String IF_VAR_EMPTY_END

See Also:: Constant Field Values

INPUT_STR_ARG_OPEN

public static final char INPUT_STR_ARG_OPEN

See Also:: Constant Field Values

INPUT_STR_ARG_CLOSE

public static final char INPUT_STR_ARG_CLOSE

See Also:: Constant Field Values

INPUT_SELECT_STR_ARG_OPEN

public static final char INPUT_SELECT_STR_ARG_OPEN

See Also:: Constant Field Values

INPUT_SELECT_STR_ARG_CLOSE

public static final char INPUT_SELECT_STR_ARG_CLOSE

See Also:: Constant Field Values

Method Detail

create

public static VariableInputDescriptor create(String label,
                                             VariableInputComponent[] components)

Create a new VariableInputDescriptor.

Parameters:: label - the label of that descriptor; components - the components which this descriptor consists of

parseItems

public static VariableInputDescriptor parseItems(String inputItems,
                                                 String[] resourceBundles)
                                          throws VariableInputFormatException

Parse the string representation of components into the descriptor object.

Parameters:: inputItems - the string representation of input components; resourceBundles - an optional array of resource bundles with localized messages
Returns:: the descriptor object
Throws:: VariableInputFormatException - when the parsed string contains some errors

getLabel

public String getLabel()

Get the label of this input descriptor.

getA11yName

public String getA11yName()

Get the accessibility name of this input descriptor.

getA11yDescription

public String getA11yDescription()

Get the accessibility description of this input descriptor.

getHelpID

public String getHelpID()

Get the help ID that should be associated with the dialog.

getAutoFillVars

public String getAutoFillVars()

Get the string representation of the auto fill variables

components

public VariableInputComponent[] components()

Get the array of components.

Returns:: the array of components.

validate

public VariableInputValidator validate()

Check, that the values of all nested components are valid.

Returns:: the validator object describing the validation

addValuesToHistory

public void addValuesToHistory()

setValuesAsDefault

public void setValuesAsDefault()

setDefaultValues

public void setDefaultValues()

getStringInputItems

public String getStringInputItems()

Get the string representation of this VariableInputDescriptor. The returned string can be parsed to the same VariableInputDescriptor as is this object.

toString

public String toString()