oracle.jdeveloper.vcs.spi
Interface VCSOptionsCustomizer

All Known Implementing Classes:

ChangeListCommentsCustomizer, VCSCommentsCustomizer, VCSCompositeOptionsCustomizer, VCSOptionsCustomizerAdapter

public interface VCSOptionsCustomizer

Interface to a version client dialog options customizer / provider.

Since:

9.0.5

Method Summary

java.awt.Component	getComponent() Gets the component of the options cusomizer instance.
java.awt.Component	getInitialFocusComponent() Get the component to focus initially when the customizer is displayed.
java.util.Map<?,?>	getOptions() Gets options from the customizer, based on internal component states.
void	setOptions(java.util.Map<?,?> options) Sets options on the customizer, updating internal component states.
void	validateOptions() Validates internal component states ahead of committing options.

Method Detail

getComponent

java.awt.Component getComponent()

Gets the component of the options cusomizer instance.

Returns:

the customzier's component.

setOptions

void setOptions(java.util.Map<?,?> options)

Sets options on the customizer, updating internal component states.

Parameters:

options - the map of options values.

getOptions

java.util.Map<?,?> getOptions()

Gets options from the customizer, based on internal component states.

Returns:

a map of options values.

validateOptions

void validateOptions()
                     throws VCSException

Validates internal component states ahead of committing options.

Throws:

VCSException - if an option states is invalid.

getInitialFocusComponent

java.awt.Component getInitialFocusComponent()

Get the component to focus initially when the customizer is displayed.

Returns:

a component to focus. (null-capable)