Module com.aoapps.hodgepodge

Package com.aoapps.hodgepodge.i18n

Class EditableResourceBundle

java.lang.Object

java.util.ResourceBundle

com.aoapps.hodgepodge.i18n.ModifiableResourceBundle

com.aoapps.hodgepodge.i18n.ModifiablePropertiesResourceBundle

com.aoapps.hodgepodge.i18n.EditableResourceBundle

All Implemented Interfaces:

Comparable<EditableResourceBundle>

public abstract class EditableResourceBundle
extends ModifiablePropertiesResourceBundle
implements Comparable<EditableResourceBundle>

Wraps the resources with XHTML and scripts to allow the modification of the resource bundle contents directly through the web interface. Also adds an indicator when the resource needs to be verified. Verification is required when any other locale has a modified time greater than the verified time of this locale.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditableResourceBundle.ThreadSettings	Settings for the current thread.

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMPTY_DISPLAY	Value used for empty strings, to avoid ambiguity.
static final String	VISIBILITY_COOKIE_NAME

Fields inherited from class com.aoapps.hodgepodge.i18n.ModifiablePropertiesResourceBundle

PROPERTIES_KEY_COMPARATOR

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EditableResourceBundle(Locale locale, EditableResourceBundleSet bundleSet, File... sourceFiles)

Method Summary

Modifier and Type	Method	Description
int	compareTo(EditableResourceBundle o)	The natural sorting is based on classname.
static EditableResourceBundle.ThreadSettings	getThreadSettings()	Gets the current settings for the current thread, initialized to ThreadSettings() when not yet set.
Object	handleGetObject(String key)	Gets an object.
static void	printEditableResourceBundleLookups(Encoder textInJavascriptEncoder, Encoder textInXhtmlEncoder, Appendable out, boolean isXhtml, int editorRows, boolean verticalButtons)	Prints the resource bundle lookup editor.
static void	printEditableResourceBundleLookups(Encoder textInJavascriptEncoder, Encoder textInXhtmlEncoder, Appendable out, int editorRows, boolean verticalButtons)	Deprecated. Please use printEditableResourceBundleLookups(com.aoapps.lang.io.Encoder, com.aoapps.lang.io.Encoder, java.lang.Appendable, boolean, int, boolean) directly, providing whether is SGML or XHTML serialization with the isXhtml flag.
static void	removeThreadSettings()	Deprecated. Please use resetThreadSettings() instead.
static void	resetRequest(boolean canEditResources, String setValueUrl, boolean modifyAllText)	Deprecated. Please use setThreadSettings(com.aoapps.util.i18n.EditableResourceBundle.ThreadSettings) or resetThreadSettings().
static void	resetThreadSettings()	Resets the settings for the current thread.
static void	setThreadSettings(EditableResourceBundle.ThreadSettings threadSettings)	Sets the settings for the current thread.

Methods inherited from class com.aoapps.hodgepodge.i18n.ModifiablePropertiesResourceBundle

getKeys, getModifiedTime, getValidatedTime, getValue, handleKeySet, handleRemoveKey, handleSetObject, isModifiable, isTrackingKey, keySetNoParents

Methods inherited from class com.aoapps.hodgepodge.i18n.ModifiableResourceBundle

removeKey, setObject, setString, setStringArray

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, keySet, setParent

Methods inherited from class java.lang.Object

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

Field Details

VISIBILITY_COOKIE_NAME

public static final String VISIBILITY_COOKIE_NAME

See Also:

• Constant Field Values

EMPTY_DISPLAY

public static final String EMPTY_DISPLAY

Value used for empty strings, to avoid ambiguity. Other submitted empty will be removed.

See Also:

• Constant Field Values

Constructor Details

EditableResourceBundle

protected EditableResourceBundle(Locale locale,
 EditableResourceBundleSet bundleSet,
 File... sourceFiles)

Method Details

getThreadSettings

public static EditableResourceBundle.ThreadSettings getThreadSettings()

Gets the current settings for the current thread, initialized to ThreadSettings() when not yet set.

resetThreadSettings

public static void resetThreadSettings()

Resets the settings for the current thread. Also removes BundleLookupThreadContext for the current thread.

removeThreadSettings

@Deprecated
public static void removeThreadSettings()

Deprecated.

Please use resetThreadSettings() instead.

Removes the settings for the current thread. Also removes BundleLookupThreadContext for the current thread.

setThreadSettings

public static void setThreadSettings(EditableResourceBundle.ThreadSettings threadSettings)

Sets the settings for the current thread. Also configures BundleLookupThreadContext for the current thread.

Parameters:

threadSettings - When null, is equivalent to resetThreadSettings().

See Also:

• printEditableResourceBundleLookups(com.aoapps.lang.io.Encoder, com.aoapps.lang.io.Encoder, java.lang.Appendable, boolean, int, boolean)

resetRequest

@Deprecated
public static void resetRequest(boolean canEditResources,
 String setValueUrl,
 boolean modifyAllText)

Deprecated.

Please use setThreadSettings(com.aoapps.util.i18n.EditableResourceBundle.ThreadSettings) or resetThreadSettings().

Any page that allows the editing of resources must set this at the beginning of the request. If not all users of the site are allowed to edit the content, must also clear this at the end of the request by either calling this method with false or calling printEditableResourceBundleLookups.

Also resets the thread lookup context.

Parameters:

setValueUrl - Must be non-null when canEditResources is true.

See Also:

• printEditableResourceBundleLookups(com.aoapps.lang.io.Encoder, com.aoapps.lang.io.Encoder, java.lang.Appendable, boolean, int, boolean)

printEditableResourceBundleLookups

public static void printEditableResourceBundleLookups(Encoder textInJavascriptEncoder,
 Encoder textInXhtmlEncoder,
 Appendable out,
 boolean isXhtml,
 int editorRows,
 boolean verticalButtons)
                                               throws IOException

Prints the resource bundle lookup editor. This should be called at the end of a request, just before the body tag is closed.

Also clears the thread lookup context.

TODO: Add language resources to properties files (but do not make it an editable properties file to avoid possible infinite recursion?) TODO: Decouple from ao-hodgepodge and use ao-fluent-html

Throws:

IOException

printEditableResourceBundleLookups

@Deprecated
public static void printEditableResourceBundleLookups(Encoder textInJavascriptEncoder,
 Encoder textInXhtmlEncoder,
 Appendable out,
 int editorRows,
 boolean verticalButtons)
                                               throws IOException

Deprecated.

Please use printEditableResourceBundleLookups(com.aoapps.lang.io.Encoder, com.aoapps.lang.io.Encoder, java.lang.Appendable, boolean, int, boolean) directly, providing whether is SGML or XHTML serialization with the isXhtml flag. This assumes XHTML serialization for backward-compatibility.

Throws:

IOException

compareTo

public int compareTo(EditableResourceBundle o)

The natural sorting is based on classname.

Specified by:

compareTo in interface Comparable<EditableResourceBundle>

handleGetObject

public Object handleGetObject(String key)

Gets an object. If editing is enabled and the bundle is modifiable, adds to the thread lookup context if present.

Overrides:

handleGetObject in class ModifiablePropertiesResourceBundle

See Also:

• BundleLookupThreadContext