JSAndCSSAdderImpl

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.olat.core.gui.control
Class JSAndCSSAdderImpl

java.lang.Object
  org.olat.core.gui.control.JSAndCSSAdder
      org.olat.core.gui.control.JSAndCSSAdderImpl

All Implemented Interfaces:: ComponentRenderer

public class JSAndCSSAdderImpl
extends JSAndCSSAdder
implements ComponentRenderer
extends JSAndCSSAdder
implements ComponentRenderer

Description:
responsible for rendering the <link rel.. and <script src=... tags in the html header.
we do not need remove methods, since in ajax-mode, any change will lead to a page reload.

Initial Date: 04.05.2006

Author:: Felix Jost

Field Summary

Fields inherited from class org.olat.core.gui.control.JSAndCSSAdder
`CSS_INDEX_AFTER_THEME, CSS_INDEX_BEFORE_THEME, CSS_INDEX_THEME`

Constructor Summary
`JSAndCSSAdderImpl(WindowBackOfficeImpl wboImpl)`

Method Summary

void addRequiredCSSFile(java.lang.Class baseClass, java.lang.String cssFileName, boolean forceRemove)
This method will add the CSS file before the theme.

void addRequiredCSSFile(java.lang.Class baseClass, java.lang.String cssFileName, boolean forceRemove, int cssLoadIndex)

void addRequiredCSSPath(java.lang.String cssPath, boolean forceRemove, int cssLoadIndex)
used rather rarely, e.g.

void addRequiredJsFile(java.lang.Class baseClass, java.lang.String jsFileName)
adds a js file to be served in the html header to the list of required js-files.

void addRequiredJsFile(java.lang.Class baseClass, java.lang.String jsFileName, java.lang.String fileEncoding)
adds a js file to be served in the html header to the list of required js-files.

void addRequiredJsFile(java.lang.Class baseClass, java.lang.String jsFileName, java.lang.String fileEncoding, java.lang.String AJAXAddJsCode)
adds a js file to be served in the html header to the list of required js-files.

void addRequiredRawHeader(java.lang.Class baseClass, java.lang.String rawHeader)

Command extractJSCSSCommand()

boolean finishAndCheckChange()

Component getJsCssRawHtmlHeader()

java.lang.String getMappedPathFor(java.lang.Class baseClass, java.lang.String fileName)
Get the mapper path for this class and file name, e.g.

void render(Renderer renderer, StringOutput sb, Component source, URLBuilder ubu, Translator translator, RenderResult renderResult, java.lang.String[] args)
calls must be threadsafe

void

renderBodyOnLoadJSFunctionCall(Renderer renderer,
                               StringOutput sb,
                               Component source,
                               RenderingState rstate)

contributes a line to the following code: ...

Specified by:: renderBodyOnLoadJSFunctionCall in interface ComponentRenderer

addRequiredRawHeader

public void addRequiredRawHeader(java.lang.Class baseClass,
                                 java.lang.String rawHeader)

Specified by:: addRequiredRawHeader in class JSAndCSSAdder

See Also:: org.olat.core.gui.control.JSAndCSSAdder#addRequiredRawHeader(java.lang.Class)

setRequiredRefreshInterval

public void setRequiredRefreshInterval(java.lang.Class baseClass,
                                       int refreshIntervall)

Specified by:: setRequiredRefreshInterval in class JSAndCSSAdder

refreshIntervall - the time in miliseconds after which (in ajax mode) a refresh of the screen is needed. use small times with caution, since it generates server load. after the given time, a poll (comet, push, hanging get for future release) is issued to the server to collect the dirty components and rerender them. when more than one interval is requested in one validation phase (=on one browser window), then the minimum is taken.

extractJSCSSCommand

public Command extractJSCSSCommand()