er.extensions.components

Class ERXStringWithLineBreaks

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.extensions.components.ERXStatelessComponent

er.extensions.components.ERXStringWithLineBreaks

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class ERXStringWithLineBreaks
extends ERXStatelessComponent

Converts a string that has line breaks and tabs in it into a corresponding HTML string with <br /> and (five of)   instead. Useful, for example, for preserving line breaks that are typed into a WOTextBox. Note that this component renders its output via a WOString element with escapeHTML=false, which is a security risk if the value being rendered comes from an untrusted source.

Synopsis

value=aString;[valueWhenEmpty=aString;]

See Also:

Serialized Form

Bindings

Name	Description
value	string to be converted
valueWhenEmpty	what to display when value is null or empty

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
String	_value Holds the HTML-ified string

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERXStringWithLineBreaks(WOContext context) Constructor

Method Summary

Modifier and Type	Method and Description
String	br()
void	reset() Nulls out cached instance variable: _value
void	setValue(Object newValue) Sets the value to be displayed.
String	tabs()
String	value() Converts '\r\n', '\n', '\r' into ' <br />' and converts '\t' into five non-breaking spaces.
protected String	valueToString(Object value)
Object	valueWhenEmpty() Returns binding valueWhenEmpty.

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

appendToResponse, invokeAction, resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

_value

public String _value

Holds the HTML-ified string

Constructor Detail

ERXStringWithLineBreaks

public ERXStringWithLineBreaks(WOContext context)

Constructor

Parameters:

context - current context

Method Detail

reset

public void reset()

Nulls out cached instance variable: _value

Overrides:

reset in class ERXStatelessComponent

value

public String value()

Converts '\r\n', '\n', '\r' into ' <br />' and converts '\t' into five non-breaking spaces.

Returns:

converted string

valueToString

protected String valueToString(Object value)

setValue

public void setValue(Object newValue)

Sets the value to be displayed. This is useful when you want to return a string from a DirectAction, for example, for debugging purposes.

Parameters:

newValue - Object to display

br

public String br()

tabs

public String tabs()

valueWhenEmpty

public Object valueWhenEmpty()

Returns binding valueWhenEmpty.

Returns:

value to display when the string is empty