org.modelio.api.module.parameter.impl

Class FileParameterModel

java.lang.Object

org.modelio.api.module.parameter.impl.ParameterModel

org.modelio.api.module.parameter.impl.FileParameterModel

All Implemented Interfaces:

IParameterModel

public class FileParameterModel
extends ParameterModel

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	allowedExtensionLabels
protected java.util.List<java.lang.String>	allowedExtensions

Constructor Summary

Constructors

Constructor and Description
FileParameterModel(IModuleUserConfiguration conf, java.lang.String name, java.lang.String label, java.lang.String description, java.lang.String defaultValue)

Method Summary

Modifier and Type	Method and Description
void	addAllowedExtension(java.lang.String extension, java.lang.String label) Add one file extension filter with its label which a dialog will use to filter the files it shows to the argument.
void	addAllowedExtensions(java.lang.String[] extensions, java.lang.String[] labels) Add file extension filters with their labels which a dialog will use to filter the files it shows to the user.
java.lang.String[]	getAllowedExtensionLabels()
java.lang.String[]	getAllowedExtensions()

Methods inherited from class org.modelio.api.module.parameter.impl.ParameterModel

getDefaultValue, getDescription, getLabel, getName, getStringValue, isLocked, setValue

Methods inherited from class java.lang.Object

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

Field Detail

allowedExtensions

protected java.util.List<java.lang.String> allowedExtensions

allowedExtensionLabels

protected java.util.List<java.lang.String> allowedExtensionLabels

Constructor Detail

FileParameterModel

public FileParameterModel(IModuleUserConfiguration conf,
                          java.lang.String name,
                          java.lang.String label,
                          java.lang.String description,
                          java.lang.String defaultValue)

Method Detail

getAllowedExtensions

public java.lang.String[] getAllowedExtensions()

getAllowedExtensionLabels

public java.lang.String[] getAllowedExtensionLabels()

addAllowedExtensions

public void addAllowedExtensions(java.lang.String[] extensions,
                                 java.lang.String[] labels)

Add file extension filters with their labels which a dialog will use to filter the files it shows to the user.

The extensions are platform specific. For example, on some platforms, an extension filter string is typically of the form "*.extension", where "*.*" matches all files. For filters with multiple extensions, use semicolon as a separator, e.g. "*.jpg;*.png".

Each label is a user-friendly short description shown for its corresponding filter. The names array must be the same length as the extensions array.

Parameters:

extensions - the allowed file extension filter

labels - the corresponding label for each extension

addAllowedExtension

public void addAllowedExtension(java.lang.String extension,
                                java.lang.String label)

Add one file extension filter with its label which a dialog will use to filter the files it shows to the argument.

The extension filter is platform specific. For example, on some platforms, an extension filter string is typically of the form "*.extension", where "*.*" matches all files. For filters with multiple extensions, use semicolon as a separator, e.g. "*.jpg;*.png".

The label is a user-friendly short description shown for its corresponding filter. The names array must be the same length as the extensions array.

Parameters:

extension - the allowed file extension filter

label - the corresponding label