er.extensions.components

Class ERXStyleSheet

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

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, Serializable, Cloneable

public class ERXStyleSheet
extends ERXStatelessComponent

Adds a style sheet to a page. You can either supply a complete URL, a file and framework name or put something in the component content. The content of the component is cached under a "key" binding and then delivered via a direct action, so it doesn't need to get re-rendered too often.

See Also:

Serialized Form

Bindings

Name	Description
filename	name of the style sheet
framework	name of the framework for the style sheet
href	url to the style sheet
key	key to cache the style sheet under when using the component content. Default is the sessionID. That means, you should *really* explicitly set a key, when you use more than one ERXStyleSheet using the component content method within one session
inline	when true, the generated link tag will be appended inline, when false it'll be placed in the head of the page, when unset it will be placed inline for ajax requests and in the head for regular requests
media	media name this style sheet is for

Properties

Name	Description
er.extensions.ERXStyleSheet.xhtml	(defaults true) if false, link tags are not closed, which is compatible with older HTML

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXStyleSheet.Sheet

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

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

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

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

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

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

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

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

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
ERXStyleSheet(com.webobjects.appserver.WOContext aContext) Public constructor

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(com.webobjects.appserver.WOResponse originalResponse, com.webobjects.appserver.WOContext wocontext) Appends the <link> tag, either by using the style sheet name and framework or by using the component content and then generating a link to it.
protected static ERXExpiringCache<String,com.webobjects.appserver.WOResponse>	cache(com.webobjects.appserver.WOSession session)
String	mediaType() Specifies on what device the linked document will be displayed.
static boolean	shouldCloseLinkTags() Returns whether or not XHTML link tags should be used.
String	styleSheetFrameworkName() Returns the style sheet framework name either resolved via the binding framework.
String	styleSheetKey() Returns key under which the stylesheet should be placed in the cache.
String	styleSheetName() Returns the style sheet name either resolved via the binding filename.
String	styleSheetUrl() Returns the complete url to the style sheet.

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless, reset

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

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

Constructor Detail

ERXStyleSheet

public ERXStyleSheet(com.webobjects.appserver.WOContext aContext)

Public constructor

Parameters:

aContext - a context

Method Detail

cache

protected static ERXExpiringCache<String,com.webobjects.appserver.WOResponse> cache(com.webobjects.appserver.WOSession session)

styleSheetUrl

public String styleSheetUrl()

Returns the complete url to the style sheet.

Returns:

style sheet url

styleSheetFrameworkName

public String styleSheetFrameworkName()

Returns the style sheet framework name either resolved via the binding framework.

Returns:

style sheet framework name

styleSheetName

public String styleSheetName()

Returns the style sheet name either resolved via the binding filename.

Returns:

style sheet name

styleSheetKey

public String styleSheetKey()

Returns key under which the stylesheet should be placed in the cache. If no key is given, the session id is used.

Returns:

cache key

mediaType

public String mediaType()

Specifies on what device the linked document will be displayed.

Returns:

media string

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse originalResponse,
                             com.webobjects.appserver.WOContext wocontext)

Appends the <link> tag, either by using the style sheet name and framework or by using the component content and then generating a link to it.

Overrides:

appendToResponse in class ERXNonSynchronizingComponent

Parameters:

originalResponse - to which we are appending

wocontext - context of the response

shouldCloseLinkTags

public static boolean shouldCloseLinkTags()

Returns whether or not XHTML link tags should be used. If false, then link tags will not be closed, which is more compatible with certain browser parsers. Set the 'er.extensions.ERXStyleSheet.xhtml' to control this property.

Returns:

true of link tags should be closed, false otherwise