Package com.install4j.api.beans
Class LocalizedExternalFile
- java.lang.Object
-
- com.install4j.api.beans.LocalizedExternalFile
-
- All Implemented Interfaces:
java.io.Serializable
public class LocalizedExternalFile extends java.lang.Object implements java.io.Serializable
Container for a set of localized files that represent a singleExternalFile
with textual content. If you want the user to be able to specify localized versions of a text file for a single property, you can declare the property to be of typeLocalizedExternalFile
. Important: you have to initialize the field with an instance rather than leave it to benull
.In the install4j IDE, the user will be presented with a dialog that allows file selection for all installer languages that are configured on the General Settings->Languages tab. At runtime, call
Context.getExternalFile(LocalizedExternalFile, boolean)
to get the actual file for further use in your bean implementation.In your bean info, use the
FilePropertyDescriptor
class to register the property. All attributes ofFilePropertyDescriptor
are supported forLocalizedExternalFile
.- See Also:
ExternalFile
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LocalizedExternalFile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,ExternalFile>
getLanguageIdToExternalFile()
Returns the map from language IDs toExternalFile
s.void
setLanguageIdToExternalFile(java.util.Map<java.lang.String,ExternalFile> languageIdToExternalFile)
Sets the map from language IDs toExternalFile
s.
-
-
-
Method Detail
-
getLanguageIdToExternalFile
public java.util.Map<java.lang.String,ExternalFile> getLanguageIdToExternalFile()
Returns the map from language IDs toExternalFile
s. You do not have to use this method, a more convenient way to retrieve the actual file at runtime is to callContext.getExternalFile(LocalizedExternalFile, boolean)
.- Returns:
- the map
-
setLanguageIdToExternalFile
public void setLanguageIdToExternalFile(java.util.Map<java.lang.String,ExternalFile> languageIdToExternalFile)
Sets the map from language IDs toExternalFile
s. This method is called by the install4j IDE.- Parameters:
languageIdToExternalFile
- the map
-
-