public abstract class ResourceBundleManagerDT extends ResourceBundleManager
ResourceBundleManagerDT
provides a base for a ResourceBundleManager
implementation for design-time._bundleMap, _bundleTypesList, _chainedBundleFactory, _keyGenerator, NULL_VALUE_RESOURCE_ID, SYSTEM_BUNDLE_ID
Constructor and Description |
---|
ResourceBundleManagerDT() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addGlobalBundle(MetaClass metaClass, java.lang.String bundleId, boolean alwaysShow)
Adds the specified bundle as a global bundle and associates it with the specified bundle id.
|
abstract void |
addGlobalBundle(NodeResourceBundle bundle, java.lang.String bundleId)
Adds the specified bundle as a global bundle and associates it with the specified bundle id
|
void |
addRegisteredBundle(Workspace workspace, java.lang.String bundleId, boolean override) |
abstract ResourceBundleWrapper |
findBundle(PropertyStorage project, java.lang.String bundleId)
Finds the bundle with the specified bundleId.
|
boolean |
generateELStyleAccess()
Returns a boolean indicating whether clients should generate EL_style access to resource bundles.
|
abstract ResourceBundleWrapper |
getBundle(PropertyStorage project, java.lang.String bundleId, boolean createBundle)
Gets (or creates) the Design Time Resource Bundle instance for the given project and bundleId
|
abstract void |
getBundle(PropertyStorage project, java.lang.String bundleId, boolean createBundle, ResourceBundleCallback callback)
Gets (or creates) the Design Time Resource Bundle instance for the given project and bundleId
|
abstract ResourceBundleWrapper |
getBundle(java.net.URL bundleURL, java.lang.String bundleId)
Gets the resource bundle for a specified URL and associates it with the specified bundleId **Note** this method should only be used by the
ResourceBundleKeyChooser and may change without notice. |
abstract java.util.List<GlobalBundleInfo> |
getGlobalBundleInfos()
Gets the list of global bundle infos
|
abstract java.util.List<NodeResourceBundle> |
getGlobalBundles()
Gets the list of global bundles
|
static boolean |
isRoleSettingBundlesReadOnly()
Returns whether the role has set the shaping for resource bundle preferences to make resource bundles read-only
|
abstract void |
removeGlobalBundle(java.lang.String bundleId)
Removes the bundle associates with the specified bundle id form the list of global bundles
|
protected static void |
setRoleSettingBundlesReadOnly(boolean readOnly)
This method is really only meant to enable unit-testing.
|
deleteBundle, getAppBundleInfoFactory, getChainedBundleFactory, getDefaultResourceKeyGenerator, getResourceBundleManager, getResourceBundleTypes, mergeBundles, registerResourceBundleType, releaseBundle, setAppBundleInfoFactory, setChainedBundleFactory, setDefaultResourceKeyGenerator, setResourceBundleManager, splitBundle
public abstract ResourceBundleWrapper findBundle(PropertyStorage project, java.lang.String bundleId)
project
- he current Project's Data that owns this file.bundleId
- The bundleId to use. The bundle ID is up to the client, however is generally either {PACKAGE_NAME} + {OBJECT_NAME} + "Bundle"
or {PACKAGE_NAME} + "Bundle"
.null
if the resource bundle does not existpublic abstract ResourceBundleWrapper getBundle(PropertyStorage project, java.lang.String bundleId, boolean createBundle)
project
- The current Project's Data that owns this file.bundleId
- The bundleId to use. This will only be significant if the project is set for one bundle per artifact. The bundle ID is up to the client, however is generally either {PACKAGE_NAME} + {OBJECT_NAME} + "Bundle"
or {PACKAGE_NAME} + "Bundle"
.createBundle
- true
if a new bundle should be created if one of the given bundleId
does not exist.null
if the resource bundle does not exist and createBundle
is false
java.lang.NullPointerException
- if project
or bundleId
is null
Note: this method may take some time to execute and thus should never be called on the event-dispatch threadpublic abstract void getBundle(PropertyStorage project, java.lang.String bundleId, boolean createBundle, ResourceBundleCallback callback)
project
- The current Project's Data that owns this file.bundleId
- bundleId The bundleId to use. This will only be significant if the project is set for one bundle per artifact. The bundle ID is up to the client, however is generally either {PACKAGE_NAME} + {OBJECT_NAME} + "Bundle"
or {PACKAGE_NAME} + "Bundle"
.createBundle
- true
if a new bundle should be created if one of the given bundleId
does not exist.callback
- the object to call when the bundle has been found, may be called back with null if no bundle foundpublic abstract ResourceBundleWrapper getBundle(java.net.URL bundleURL, java.lang.String bundleId)
ResourceBundleKeyChooser
and may change without notice.bundleURL
- the URL to use to create a resource bundlebundleId
- the fully-qualified name to associate with the resource bundlepublic abstract void addGlobalBundle(NodeResourceBundle bundle, java.lang.String bundleId)
bundle
- the bundle to add to the list of global bundlesbundleId
- the id to associate with the bundle insteadpublic abstract void addGlobalBundle(MetaClass metaClass, java.lang.String bundleId, boolean alwaysShow)
metaClass
- the MetaClass that represents the design-time implementation of the bundlebundleId
- the id to associate with the bundle. This id will be stored in generated code to reference the bundle so typically it would also be the fully-qualified class namealwaysShow
- true if the bundle should always be added to the SelectTextPanel's dropdown list of bundles; false otherwisepublic abstract void removeGlobalBundle(java.lang.String bundleId)
bundleId
- the id associated with the bundle to removepublic abstract java.util.List<NodeResourceBundle> getGlobalBundles()
public abstract java.util.List<GlobalBundleInfo> getGlobalBundleInfos()
public static boolean isRoleSettingBundlesReadOnly()
protected static void setRoleSettingBundlesReadOnly(boolean readOnly)
readOnly
-public boolean generateELStyleAccess()
public void addRegisteredBundle(Workspace workspace, java.lang.String bundleId, boolean override)