}
@Override
public void encodeBegin(FacesContext facesContext, UIComponent component) throws IOException {
UIPage page = (UIPage) component;
// invoke prepareRender
RenderUtils.prepareRendererAll(facesContext, page);
LayoutContext layoutContext = new LayoutContext(page);
layoutContext.layout();
TobagoResponseWriter writer = HtmlRendererUtils.getTobagoResponseWriter(facesContext);
// reset responseWriter and render page
facesContext.setResponseWriter(writer);
ResponseUtils.ensureNoCacheHeader(facesContext);
if (LOG.isDebugEnabled()) {
for (Object o : page.getAttributes().entrySet()) {
Map.Entry entry = (Map.Entry) o;
LOG.debug("*** '" + entry.getKey() + "' -> '" + entry.getValue() + "'");
}
}
Application application = facesContext.getApplication();
ViewHandler viewHandler = application.getViewHandler();
String viewId = facesContext.getViewRoot().getViewId();
String formAction = viewHandler.getActionURL(facesContext, viewId);
formAction = facesContext.getExternalContext().encodeActionURL(formAction);
String contentType = writer.getContentTypeWithCharSet();
ResponseUtils.ensureContentTypeHeader(facesContext, contentType);
String clientId = page.getClientId(facesContext);
final ClientProperties client = VariableResolverUtils.resolveClientProperties(facesContext);
final ProjectStage projectStage = TobagoConfig.getInstance(facesContext).getProjectStage();
final boolean developmentMode = projectStage == ProjectStage.Development;
final boolean debugMode = client.isDebugMode() || developmentMode;
final boolean productionMode = !debugMode && projectStage == ProjectStage.Production;
boolean calculateScrollbarWeight = false;
int clientLogSeverity = 2;
if (debugMode) {
String severity = (String) facesContext.getExternalContext().getRequestMap().get(CLIENT_DEBUG_SEVERITY);
if (LOG.isDebugEnabled()) {
LOG.debug("get " + CLIENT_DEBUG_SEVERITY + " = " + severity);
}
if (severity != null) {
try {
int index = severity.indexOf(';');
if (index == -1) {
index = severity.length();
}
clientLogSeverity = Integer.parseInt(severity.substring(0, index));
} catch (NumberFormatException e) {/* ignore; use default*/ }
}
}
if (!FacesContextUtils.isAjax(facesContext)) {
HtmlRendererUtils.renderDojoDndSource(facesContext, component);
String title = (String) page.getAttributes().get(Attributes.LABEL);
writer.startElement(HtmlElements.HEAD, null);
// meta tags
// this is needed, because websphere 6.0? ignores the setting of the content type on the response
writer.startElement(HtmlElements.META, null);
writer.writeAttribute(HtmlAttributes.HTTP_EQUIV, "Content-Type", false);
writer.writeAttribute(HtmlAttributes.CONTENT, contentType, false);
writer.endElement(HtmlElements.META);
// title
writer.startElement(HtmlElements.TITLE, null);
writer.writeText(title != null ? title : "");
writer.endElement(HtmlElements.TITLE);
final Theme theme = client.getTheme();
if (debugMode) {
// This tag must not be earlier, because the
// IE doesn't accept some META tags, when they are not the first ones.
writer.writeJavascript("var TbgHeadStart = new Date();");
}
// style files
for (String styleFile : theme.getStyleResources(productionMode)) {
writeStyle(facesContext, writer, styleFile);
}
for (String styleFile : FacesContextUtils.getStyleFiles(facesContext)) {
writeStyle(facesContext, writer, styleFile);
}
String icon = page.getApplicationIcon();
if (icon != null) {
// XXX unify with image renderer
if (ResourceManagerUtils.isAbsoluteResource(icon)) {
// absolute Path to image : nothing to do
} else {
icon = ResourceManagerUtils.getImageWithPath(facesContext, icon);
}
writer.startElement(HtmlElements.LINK, null);
if (icon.endsWith(".ico")) {
writer.writeAttribute(HtmlAttributes.REL, "shortcut icon", false);
writer.writeAttribute(HtmlAttributes.HREF, icon, false);
} else {
// XXX IE only supports ICO files for favicons
writer.writeAttribute(HtmlAttributes.REL, "icon", false);
writer.writeAttribute(HtmlAttributes.TYPE, MimeTypeUtils.getMimeTypeForFile(icon), false);
writer.writeAttribute(HtmlAttributes.HREF, icon, false);
}
writer.endElement(HtmlElements.LINK);
}
// style sniplets
Set<String> styleBlocks = FacesContextUtils.getStyleBlocks(facesContext);
if (styleBlocks.size() > 0) {
writer.startElement(HtmlElements.STYLE, null);
writer.flush(); // is needed in some cases, e. g. TOBAGO-1094
for (String cssBlock : styleBlocks) {
writer.write(cssBlock);
}
writer.endElement(HtmlElements.STYLE);
}
if (debugMode) {
boolean hideClientLogging = true;
String severity = (String) facesContext.getExternalContext().getRequestMap().get(CLIENT_DEBUG_SEVERITY);
if (LOG.isDebugEnabled()) {
LOG.debug("get " + CLIENT_DEBUG_SEVERITY + " = " + severity);
}
if (severity != null) {
try {
int index = severity.indexOf(';');
if (index == -1) {
index = severity.length();
}
clientLogSeverity = Integer.parseInt(severity.substring(0, index));
} catch (NumberFormatException e) {/* ignore; use default*/ }
hideClientLogging = !severity.contains("show");
}
// the jquery ui is used in moment only for the logging area...
FacesContextUtils.addOnloadScript(facesContext, 0, "new LOG.LogArea({hide: " + hideClientLogging + "});");
}
// render remaining script tags
for (String scriptFile: theme.getScriptResources(productionMode)) {
encodeScript(facesContext, writer, scriptFile);
}
for (String scriptFile : FacesContextUtils.getScriptFiles(facesContext)) {
encodeScript(facesContext, writer, scriptFile);
}
// focus id
String focusId = page.getFocusId();
if (focusId != null) {
writer.startJavascript();
writer.write("Tobago.focusId = '");
writer.write(focusId);
writer.write("';");
writer.endJavascript();
}
if (component.getFacets().containsKey(Facets.ACTION)) {
UIComponent command = component.getFacet(Facets.ACTION);
if (command != null && command.isRendered()) {
int duration = ComponentUtils.getIntAttribute(command, Attributes.DELAY, 100);
boolean transition = ComponentUtils.getBooleanAttribute(command, Attributes.TRANSITION);
String target = ComponentUtils.getStringAttribute(command, Attributes.TARGET);
String action
= HtmlRendererUtils.createSubmitAction(command.getClientId(facesContext), transition, target, null);
FacesContextUtils.addOnloadScript(facesContext, "setTimeout(\"" + action + "\", " + duration + ");\n");
}
}
calculateScrollbarWeight
= client.getVerticalScrollbarWeight() == null || client.getHorizontalScrollbarWeight() == null;
if (calculateScrollbarWeight) {
FacesContextUtils.addOnloadScript(facesContext,
"Tobago.calculateScrollbarWeights('" + clientId + ComponentUtils.SUB_SEPARATOR + "scrollbarWeight" + "');");
} else {
FacesContextUtils.addOnloadScript(facesContext,
"Tobago.Config.set('Tobago', 'verticalScrollbarWeight', '"
+ client.getVerticalScrollbarWeight().getPixel() + "');");
FacesContextUtils.addOnloadScript(facesContext,
"Tobago.Config.set('Tobago', 'horizontalScrollbarWeight', '"
+ client.getHorizontalScrollbarWeight().getPixel() + "');");
}
UIComponent command = null;
if (component.getFacets().containsKey(Facets.RESIZE_ACTION)) {
Deprecation.LOG.warn("Please use 'resize' instead of 'resizeAction' as facet.");
UIComponent facet = component.getFacet(Facets.RESIZE_ACTION);
if (facet instanceof UICommand) {
command = facet;
} else if (facet instanceof UIForm && facet.getChildCount() == 1) {
Deprecation.LOG.warn("Please don't use a form, but a command with immediate=true instead.");
command = (UIComponent) facet.getChildren().get(0);
}
}
if (component.getFacets().containsKey(Facets.RESIZE)) {
UIComponent facet = component.getFacet(Facets.RESIZE);
if (facet instanceof UICommand) {
command = facet;
} else if (facet instanceof UIForm && facet.getChildCount() == 1) {
Deprecation.LOG.warn("Please don't use a form, but a command with immediate=true instead.");
command = (UIComponent) facet.getChildren().get(0);
}
}
if (command != null && command.isRendered()) {
final CommandRendererHelper helper = new CommandRendererHelper(facesContext, (AbstractUICommandBase) command);
if (!helper.isDisabled()) {
writer.writeJavascript("Tobago.resizeAction = function() {\n" + helper.getOnclick() + "\n};\n");
}
}
writer.startJavascript();
// onload script
writeEventFunction(writer, FacesContextUtils.getOnloadScripts(facesContext), "load", false);
// onunload script
writeEventFunction(writer, FacesContextUtils.getOnunloadScripts(facesContext), "unload", false);
// onexit script
writeEventFunction(writer, FacesContextUtils.getOnexitScripts(facesContext), "exit", false);
writeEventFunction(writer, FacesContextUtils.getOnsubmitScripts(facesContext), "submit", true);
int debugCounter = 0;
for (String scriptBlock : FacesContextUtils.getScriptBlocks(facesContext)) {
if (LOG.isDebugEnabled()) {
LOG.debug("write scriptblock " + ++debugCounter + " :\n" + scriptBlock);
}
writer.write(scriptBlock);
writer.write('\n');
}
writer.endJavascript();
writer.endElement(HtmlElements.HEAD);
}
String defaultActionId = page.getDefaultActionId() != null ? page.getDefaultActionId() : "";
writer.startElement(HtmlElements.BODY, page);
writer.writeAttribute(HtmlAttributes.ONLOAD, "Tobago.init('" + clientId + "');", false);
// writer.writeAttribute("onunload", "Tobago.onexit();", null);
writer.writeIdAttribute(clientId);
writer.writeClassAttribute(Classes.create(page));
writer.startJavascript();
writer.write("Tobago.pngFixBlankImage = '");
writer.write(ResourceManagerUtils.getImageWithPath(facesContext, "image/blank.gif"));
writer.write("';\n");
writer.write("Tobago.OVERLAY_BACKGROUND = '");
writer.write(ResourceManagerUtils.getImageWithPath(facesContext, "image/tobago-overlay-background.png"));
writer.write("';\n");
writer.endJavascript();
/*
if (debugMode) {
final String[] jsFiles = new String[]{
"script/logging.js"
};
final String[] jsCommand = new String[]{"new LOG.LogArea({hide: " + hideClientLogging + "});"};
HtmlRendererUtils.writeScriptLoader(facesContext, jsFiles, jsCommand);
writer.writeJavascript("TbgTimer.startBody = new Date();");
}
*/
if (debugMode) {
writer.writeJavascript("TbgTimer.startBody = new Date();");
}
writer.startElement(HtmlElements.FORM, page);
writer.writeAttribute(HtmlAttributes.ACTION, formAction, true);
writer.writeIdAttribute(page.getFormId(facesContext));
writer.writeAttribute(HtmlAttributes.METHOD, getMethod(page), false);
String enctype = FacesContextUtils.getEnctype(facesContext);
if (enctype != null) {
writer.writeAttribute(HtmlAttributes.ENCTYPE, enctype, false);
}
// TODO: enable configuration of 'accept-charset'
writer.writeAttribute(HtmlAttributes.ACCEPT_CHARSET, AbstractUIPage.FORM_ACCEPT_CHARSET, false);
// TODO evaluate 'accept' attribute usage
//writer.writeAttribute(HtmlAttributes.ACCEPT, );
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeNameAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "form-action");
writer.writeIdAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "form-action");
writer.writeAttribute(HtmlAttributes.VALUE, defaultActionId, true);
writer.endElement(HtmlElements.INPUT);
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeNameAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "context-path");
writer.writeIdAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "context-path");
writer.writeAttribute(HtmlAttributes.VALUE, facesContext.getExternalContext().getRequestContextPath(), true);
writer.endElement(HtmlElements.INPUT);
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeNameAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "action-position");
writer.writeIdAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "action-position");
writer.endElement(HtmlElements.INPUT);
if (calculateScrollbarWeight) {
writer.startElement(HtmlElements.DIV, null);
writer.writeClassAttribute(Classes.create(page, "scrollbarWeight", Markup.NULL));
writer.startElement(HtmlElements.DIV, null);
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.DIV);
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeNameAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "scrollbarWeight");
writer.writeIdAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "scrollbarWeight");
writer.endElement(HtmlElements.INPUT);
}
if (TobagoConfig.getInstance(FacesContext.getCurrentInstance()).isCreateSessionSecret()) {
Secret.encode(facesContext, writer);
}
if (debugMode) {
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.VALUE, clientLogSeverity);
writer.writeAttribute(HtmlAttributes.ID, clientId + ComponentUtils.SUB_SEPARATOR + "clientSeverity", false);
writer.writeAttribute(HtmlAttributes.NAME, clientId + ComponentUtils.SUB_SEPARATOR + "clientSeverity", false);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.endElement(HtmlElements.INPUT);
}
if (component.getFacet("backButtonDetector") != null) {
UIComponent hidden = component.getFacet("backButtonDetector");
RenderUtils.encode(facesContext, hidden);
}
String lastFocusId = (String) component.getAttributes().get(LAST_FOCUS_ID);
if (lastFocusId != null) {
writer.writeJavascript("Tobago.lastFocusId = '" + lastFocusId + "';");
component.getAttributes().remove(LAST_FOCUS_ID);
}
//checkForCommandFacet(component, facesContext, writer);
// TODO: this is needed for the "BACK-BUTTON-PROBLEM"
// but may no longer needed
/*
if (ViewHandlerImpl.USE_VIEW_MAP) {
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, "hidden", null);
writer.writeNameAttribute(ViewHandlerImpl.PAGE_ID);
writer.writeIdAttribute(ViewHandlerImpl.PAGE_ID);
Object value = facesContext.getViewRoot().getAttributes().get(
ViewHandlerImpl.PAGE_ID);
writer.writeAttribute(HtmlAttributes.VALUE, (value != null ? value : ""), null);
writer.endElement(HtmlElements.INPUT);
}
*/
UIMenuBar menuBar = (UIMenuBar) page.getFacet(Facets.MENUBAR);
if (menuBar != null) {
menuBar.getAttributes().put(Attributes.PAGE_MENU, Boolean.TRUE);
RenderUtils.encode(facesContext, menuBar);
}
// write the previously rendered page content
// AbstractUILayoutBase.getLayout(component).encodeChildrenOfComponent(facesContext, component);
// page.encodeLayoutBegin(facesContext);
writer.startElement(HtmlElements.DIV, page);
writer.writeClassAttribute(Classes.create(page, "content"));
writer.writeIdAttribute(clientId + ComponentUtils.SUB_SEPARATOR + "content");
Style style = new Style(facesContext, page);
// XXX position the div, so that the scrollable area is correct.
// XXX better to take this fact into layout management.
// XXX is also useful in boxes, etc.
Measure border = getBorderBottom(facesContext, page);
style.setHeight(page.getCurrentHeight().subtract(border));
style.setTop(border);
writer.writeStyleAttribute(style);
}