org.eclipse.emf.facet.custom.ui.internal.exported.dialog
Interface ILoadCustomizationsDialog<D>

public interface ILoadCustomizationsDialog<D>

A dialog to load Customizations.

Since:

0.2.0

Method Summary

void	addCustomization(Customization customization) This method is used to add a customization on the top of the customization stack.
void	addCustomizations(java.util.List<Customization> customizations) This method is used to add customizations on the top of the customization stack.
void	asyncOpen() Opens the dialog asynchronously
void	cancel() Cancel the dialog
java.util.List<Customization>	getAvailableCustomizations() The intersection between getSelectedCustomizations() and getAvailableCustomizations') has to be empty.
java.util.List<Customization>	getSelectedCustomizations() The intersection between getSelectedCustomizations() and getAvailableCustomizations') has to be empty.
void	loadSelectedCustoms() Moves the customizations selected in the left "available customizations" pane to the right "loaded customizations" pane.
int	open() Opens the dialog and blocks until it closes.
D	pressOk() Emulate a press on the OK button
void	pushDown(Customization customization) This method is used to push down a customization.
void	pushUp(Customization customization) This method is used to push up a customization.
void	removeCustomization(Customization customization) This method is used to remove a customization from the list.
void	removeCustomizations(java.util.List<Customization> customizations) This method is used to remove a list of customization from the list.
void	selectAvailableCustom(Customization customization) Selects the given customization in the left "available customizations" pane
void	selectSelectedCustom(Customization customization) Selects the given customization in the right "loaded customizations" pane
void	unloadSelectedCustoms() Moves the customizations selected in the right "loaded customizations" pane to the left "available customizations" pane.
void	validate() Validate the dialog

Method Detail

open

int open()

Opens the dialog and blocks until it closes.

Returns:

the dialog's return code

asyncOpen

void asyncOpen()

Opens the dialog asynchronously

pressOk

D pressOk()

Emulate a press on the OK button

Since:

0.2

selectAvailableCustom

void selectAvailableCustom(Customization customization)

Selects the given customization in the left "available customizations" pane

loadSelectedCustoms

void loadSelectedCustoms()

Moves the customizations selected in the left "available customizations" pane to the right "loaded customizations" pane.

selectSelectedCustom

void selectSelectedCustom(Customization customization)

Selects the given customization in the right "loaded customizations" pane

unloadSelectedCustoms

void unloadSelectedCustoms()

Moves the customizations selected in the right "loaded customizations" pane to the left "available customizations" pane.

addCustomization

void addCustomization(Customization customization)
                      throws IllegalParameterException

This method is used to add a customization on the top of the customization stack.

Parameters:

customization - must be one element of the list returned by ICustomizationLoaderDialo.getAvailableCustomizations()

Throws:

IllegalParameterException - when the parameter is not one element of the list returned by ICustomizationLoaderDialo.getAvailableCustomizations()

addCustomizations

void addCustomizations(java.util.List<Customization> customizations)
                       throws IllegalParameterException

This method is used to add customizations on the top of the customization stack.

Parameters:

customizations - must be one element of the list returned by ICustomizationLoaderDialo.getAvailableCustomizations()

Throws:

IllegalParameterException - when one of the element of the parameter list in not one element of the list returned by ICustomizationLoaderDialo.getAvailableCustomizations()

removeCustomization

void removeCustomization(Customization customization)
                         throws IllegalParameterException

This method is used to remove a customization from the list.

Parameters:

customization - must be one element of the list returned by ICustomizationLoaderDialo.getSelectedCustomizations()

Throws:

IllegalParameterException - when the parameter is not one element of the list returned by ICustomizationLoaderDialo.getSelectedCustomizations()

removeCustomizations

void removeCustomizations(java.util.List<Customization> customizations)
                          throws IllegalParameterException

This method is used to remove a list of customization from the list.

Parameters:

customizations - must be one element of the list returned by ICustomizationLoaderDialo.getSelectedCustomizations()

Throws:

IllegalParameterException - when one of the element of the parameter list in not one element of the list returned by ICustomizationLoaderDialo.getSelectedCustomizations()

cancel

void cancel()

Cancel the dialog

validate

void validate()

Validate the dialog

getSelectedCustomizations

java.util.List<Customization> getSelectedCustomizations()

The intersection between getSelectedCustomizations() and getAvailableCustomizations') has to be empty.

Returns:

the customizations selected using the dialog.

getAvailableCustomizations

java.util.List<Customization> getAvailableCustomizations()

The intersection between getSelectedCustomizations() and getAvailableCustomizations') has to be empty.

Returns:

the available and not yet selected customizations

pushUp

void pushUp(Customization customization)
            throws IllegalParameterException

This method is used to push up a customization.

Parameters:

customization - a selected customization.

Throws:

IllegalParameterException - when the parameter in not on element of the list returned by getSelectedCustomizations().

pushDown

void pushDown(Customization customization)
              throws IllegalParameterException

This method is used to push down a customization.

Parameters:

customization - a selected customization.

Throws:

IllegalParameterException - when the parameter in not on element of the list returned by getSelectedCustomizations().