er.extensions
Class ERXStringWithLineBreaks

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.ERXNonSynchronizingComponent
              er.extensions.ERXStatelessComponent
                  er.extensions.ERXStringWithLineBreaks

All Implemented Interfaces:

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

public class ERXStringWithLineBreaks

extends ERXStatelessComponent

Simple component that can convert a string that has line breaks and tabs in it into an html string that has
and instead. Very useful for preserving line breaks that are typed into a WOTextBox.
Synopsis:
value=aString;[valueWhenEmpty=aString;]

See Also:

Serialized Form

Bindings

value	string to be converted
valueWhenEmpty	if null or length of zero what to display

Nested Class Summary

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

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes inherited from class 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.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes inherited from class com.webobjects.foundation.NSValidation

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

Field Summary

String

_value holds the html-ified string

Fields inherited from class er.extensions.ERXNonSynchronizingComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

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.NSValidation

_CLASS

Constructor Summary

ERXStringWithLineBreaks(WOContext context)
Public constructor

Method Summary

String	br()
void	reset() Nulls out cached instance variable: _value
void	setValue(Object newValue) Set 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.ERXStatelessComponent

isStateless, valueForBooleanBinding, valueForBooleanBinding, valueForBooleanBinding, valueForIntBinding, valueForObjectBinding, valueForObjectBinding

Methods inherited from class er.extensions.ERXNonSynchronizingComponent

booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, dynamicBindings, intValueForBinding, localizer, objectValueForBinding, objectValueForBinding, stringValueForBinding, stringValueForBinding, synchronizesVariablesWithBindings

Methods inherited from class com.webobjects.appserver.WOComponent

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

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)

Public 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:

converts string bound to binding: value into html-ified line breaks.

valueToString

protected String valueToString(Object value)

setValue

public void setValue(Object newValue)

Set 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