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

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/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.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.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations, MINUSONE

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. This is useful when you want to return a string from a DirectAction for example for debugging purposes.
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, valueForBooleanBinding, valueForBooleanBinding, valueForBooleanBinding, valueForIntBinding, valueForObjectBinding, valueForObjectBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

synchronizesVariablesWithBindings

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, appendToResponse, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, invokeAction, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, stringValueForBinding, stringValueForBinding, takeValuesFromRequest, 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, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding

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