/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.vaadin.smartgwt.server;
import java.util.Map;
import org.vaadin.smartgwt.server.types.ContentsType;
import org.vaadin.smartgwt.server.types.SendMethod;
import org.vaadin.smartgwt.server.util.EnumUtil;
import com.vaadin.terminal.PaintException;
import com.vaadin.terminal.PaintTarget;
import com.vaadin.terminal.Resource;
import com.vaadin.ui.ClientWidget;
/**
* Use the HTMLFlow component to display HTML content that should expand to its natural size without scrolling. <p> HTML
* content can be loaded and reloaded from a URL via the property <code>contentsURL</code>. This method of loading is for
* simple HTML content only; Smart GWT components should be loaded via the {@link com.smartgwt.client.widgets.ViewLoader}
* class. <P> NOTE: Since the size of an HTMLFlow component is determined by its HTML contents, this component will draw at
* varying sizes if given content of varying size. When using HTMLFlow components within a Layout, consider what will
* happen if the HTMLFlow renders at various sizes. An HTMLFlow which can expand should be placed in a container where
* other components can render smaller, where the container is allowed to scroll, or where there is padding to expand into.
*/
@ClientWidget(org.vaadin.smartgwt.client.ui.VHTMLFlow.class)
public class HTMLFlow extends Canvas {
private Resource contentsResource;
public HTMLFlow() {
scClassName = "HTMLFlow";
}
public HTMLFlow(String contents) {
setContents(contents);
scClassName = "HTMLFlow";
}
// ********************* Properties / Attributes ***********************
/**
* By default an HTMLFlow will explicitly prevent browser caching. <P> Set to true to allow browser caching <b>if the
* browser would normally do so</b>, in other words, if the HTTP headers returned with the response indicate that the
* response can be cached.
*
* @param allowCaching allowCaching Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setAllowCaching(Boolean allowCaching) throws IllegalStateException {
setAttribute("allowCaching", allowCaching, false);
}
/**
* By default an HTMLFlow will explicitly prevent browser caching. <P> Set to true to allow browser caching <b>if the
* browser would normally do so</b>, in other words, if the HTTP headers returned with the response indicate that the
* response can be cached.
*
*
* @return Boolean
*/
public Boolean getAllowCaching() {
return getAttributeAsBoolean("allowCaching");
}
/**
* If true, Smart GWT components created while executing the loaded HTML are captured for rendering inside the HTMLFlow.
* <P> Only applies when contentsType is <b>not</b> "page".
*
* @param captureSCComponents captureSCComponents Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setCaptureSCComponents(Boolean captureSCComponents) throws IllegalStateException {
setAttribute("captureSCComponents", captureSCComponents, false);
}
/**
* If true, Smart GWT components created while executing the loaded HTML are captured for rendering inside the HTMLFlow.
* <P> Only applies when contentsType is <b>not</b> "page".
*
*
* @return Boolean
*/
public Boolean getCaptureSCComponents() {
return getAttributeAsBoolean("captureSCComponents");
}
/**
* The contents of a canvas or label widget. Any HTML string is acceptable.
*
* @param contents contents Default value is " "
* @see com.smartgwt.client.widgets.HTMLFlow#setDynamicContents
*/
public void setContents(String contents) {
setAttribute("contents", contents, true);
}
/**
* The contents of a canvas or label widget. Any HTML string is acceptable.
*
*
* @return String
* @see com.smartgwt.client.widgets.HTMLFlow#getDynamicContents
*/
public String getContents() {
return getAttributeAsString("contents");
}
/**
* URL to load content from. <P> If specified, this component will load HTML content from the specified URL when it is
* first drawn. <p> This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported
* browsers. See {@link com.smartgwt.client.docs.PlatformDependencies} for more information.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Change the URL this component loads content from. Triggers a fetch for content from the new URL. <p> Can also be called with no arguments to reload content from the existing {@link com.smartgwt.client.widgets.HTMLFlow#getContentsURL contentsURL}. <P> This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See {@link com.smartgwt.client.docs.PlatformDependencies} for more information.
*
* @param contentsURL URL to retrieve contents from. Default value is null
*/
public void setContentsURL(String contentsURL) {
setAttribute("contentsURL", contentsURL, true);
}
/**
* URL to load content from. <P> If specified, this component will load HTML content from the specified URL when it is
* first drawn. <p> This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported
* browsers. See {@link com.smartgwt.client.docs.PlatformDependencies} for more information.
*
*
* @return String
*/
public String getContentsURL() {
return getAttributeAsString("contentsURL");
}
/**
* Vaadin resource to load content from. <P> If specified, this component will load HTML content from the specified Vaadin
* URL when it is first drawn. <p> This feature relies on the XMLHttpRequest object which can be disabled by end-users in
* some supported browsers. See {@link com.smartgwt.client.docs.PlatformDependencies} for more information.
*/
@VaadinIntegration
public void setContentsResource(Resource contentsResource) {
this.contentsResource = contentsResource;
}
/**
* Vaadin resource to load content from. <P> If specified, this component will load HTML content from the specified Vaadin
* URL when it is first drawn. <p> This feature relies on the XMLHttpRequest object which can be disabled by end-users in
* some supported browsers. See {@link com.smartgwt.client.docs.PlatformDependencies} for more information.
*/
@VaadinIntegration
public Resource getContentsResource() {
return contentsResource;
}
/**
* Dynamic contents allows the contents string to be treated as a simple, but powerful
* template. When this attribute is set to true, expressions of the form \${arbitrary JS
* here} are replaced by the result of the evaluation of the JS code inside the curly
* brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation
* of the expressions in the contents string you can call markForRedraw() on the canvas.
* <p>
* You can use this feature to build some simple custom components. For example, let's say
* you want to show the value of a Slider in a Canvas somewhere on the screen. You can do
* this by observing the valueChanged() method on the slider and calling setContents() on
* your canvas with the new string or you can set the contents of the canvas to something
* like:
* <p><code>
* "The slider value is \${sliderInstance.getValue()}."
* </code><p>
* Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider
* and call canvas.markForRedraw() in that observation. This approach is cleaner than
* setContents() when the Canvas is aggregating several values or dynamic expressions.
* Like so:
* <p>
* <pre>
* Slider.create({
* ID: "mySlider"
* });
*
* Canvas.create({
* ID: "myCanvas",
* dynamicContents: true,
* contents: "The slider value is \${mySlider.getValue()}."
* });
*
* myCanvas.observe(mySlider, "valueChanged",
* "observer.markForRedraw()");
* </pre>
* You can embed an arbitrary number of dynamic expressions in the contents string. The
* search and replace is optimized for speed.
* <p>
* If an error occurs during the evaluation of one of the expressions, a warning is logged
* to the ISC Developer Console and the error string is embedded in place of the expected
* value in the Canvas.
* <p>
* The value of a function is its return value. The value of any variable is the same as
* that returned by its toString() representation.
* <p>
* Inside the evaluation contentext, <code>this</code> points to the canvas instance that
* has the dynamicContents string as its contents - in other words the canvas instance on
* which the template is declared.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dynamicContents dynamicContents Default value is false
* @see com.smartgwt.client.widgets.HTMLFlow#setContents
* @see com.smartgwt.client.widgets.Canvas#setDynamicContentsVars
*
*/
public void setDynamicContents(Boolean dynamicContents) {
setAttribute("dynamicContents", dynamicContents, true);
}
/**
* Dynamic contents allows the contents string to be treated as a simple, but powerful
* template. When this attribute is set to true, expressions of the form \${arbitrary JS
* here} are replaced by the result of the evaluation of the JS code inside the curly
* brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation
* of the expressions in the contents string you can call markForRedraw() on the canvas.
* <p>
* You can use this feature to build some simple custom components. For example, let's say
* you want to show the value of a Slider in a Canvas somewhere on the screen. You can do
* this by observing the valueChanged() method on the slider and calling setContents() on
* your canvas with the new string or you can set the contents of the canvas to something
* like:
* <p><code>
* "The slider value is \${sliderInstance.getValue()}."
* </code><p>
* Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider
* and call canvas.markForRedraw() in that observation. This approach is cleaner than
* setContents() when the Canvas is aggregating several values or dynamic expressions.
* Like so:
* <p>
* <pre>
* Slider.create({
* ID: "mySlider"
* });
*
* Canvas.create({
* ID: "myCanvas",
* dynamicContents: true,
* contents: "The slider value is \${mySlider.getValue()}."
* });
*
* myCanvas.observe(mySlider, "valueChanged",
* "observer.markForRedraw()");
* </pre>
* You can embed an arbitrary number of dynamic expressions in the contents string. The
* search and replace is optimized for speed.
* <p>
* If an error occurs during the evaluation of one of the expressions, a warning is logged
* to the ISC Developer Console and the error string is embedded in place of the expected
* value in the Canvas.
* <p>
* The value of a function is its return value. The value of any variable is the same as
* that returned by its toString() representation.
* <p>
* Inside the evaluation contentext, <code>this</code> points to the canvas instance that
* has the dynamicContents string as its contents - in other words the canvas instance on
* which the template is declared.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.HTMLFlow#getContents
* @see com.smartgwt.client.widgets.Canvas#getDynamicContentsVars
*
*/
public Boolean getDynamicContents() {
return getAttributeAsBoolean("dynamicContents");
}
/**
* If <code>evalScriptBlocks</code> is true, HTMLFlow will pre-process the loaded HTML in order to mimic how the HTML would
* execute if it were loaded as an independent page or loaded via an IFRAME. <P> This feature is intended to assist with
* migrating existing applications to Smart GWT. <P> Note that, if evalScriptBlocks is false, <SCRIPT> blocks will
* still be detected and disabled to avoid the inconsistent results across different browsers. <P> Only applies when
* contentsType is <b>not</b> "page".
*
* @param evalScriptBlocks evalScriptBlocks Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setEvalScriptBlocks(Boolean evalScriptBlocks) throws IllegalStateException {
setAttribute("evalScriptBlocks", evalScriptBlocks, false);
}
/**
* If <code>evalScriptBlocks</code> is true, HTMLFlow will pre-process the loaded HTML in order to mimic how the HTML would
* execute if it were loaded as an independent page or loaded via an IFRAME. <P> This feature is intended to assist with
* migrating existing applications to Smart GWT. <P> Note that, if evalScriptBlocks is false, <SCRIPT> blocks will
* still be detected and disabled to avoid the inconsistent results across different browsers. <P> Only applies when
* contentsType is <b>not</b> "page".
*
*
* @return Boolean
*/
public Boolean getEvalScriptBlocks() {
return getAttributeAsBoolean("evalScriptBlocks");
}
/**
* Selects the HTTP method that will be used when fetching content. Valid values are "POST" and "GET".
*
* @param httpMethod httpMethod Default value is "GET"
*/
public void setHttpMethod(SendMethod httpMethod) {
setAttribute("httpMethod", httpMethod.getValue(), true);
}
/**
* Selects the HTTP method that will be used when fetching content. Valid values are "POST" and "GET".
*
*
* @return SendMethod
*/
public SendMethod getHttpMethod() {
return EnumUtil.getEnum(SendMethod.values(), getAttribute("httpMethod"));
}
/**
* HTML to show while content is being fetched, active only if the <code>contentsURL</code> property has been set. Use
* <code>"\${loadingImage}"</code> to include {@link com.smartgwt.client.widgets.Canvas#loadingImageSrc a loading image}.
* <P> The loading message will show both during the initial load of content, and during reload if the contents are
* reloaded or the contentsURL changed. For a first-time only loading message, initialize the <code>contents</code>
* property instead.<br> Note: the <code>loadingMessage</code> is never displayed when loading complete web pages rather
* than HTML fragments (see {@link com.smartgwt.client.widgets.HTMLFlow#getContentsType contentsType}).
*
* @param loadingMessage loadingMessage Default value is " \${loadingImage}"
*/
public void setLoadingMessage(String loadingMessage) {
setAttribute("loadingMessage", loadingMessage, true);
}
/**
* HTML to show while content is being fetched, active only if the <code>contentsURL</code> property has been set. Use
* <code>"\${loadingImage}"</code> to include {@link com.smartgwt.client.widgets.Canvas#loadingImageSrc a loading image}.
* <P> The loading message will show both during the initial load of content, and during reload if the contents are
* reloaded or the contentsURL changed. For a first-time only loading message, initialize the <code>contents</code>
* property instead.<br> Note: the <code>loadingMessage</code> is never displayed when loading complete web pages rather
* than HTML fragments (see {@link com.smartgwt.client.widgets.HTMLFlow#getContentsType contentsType}).
*
*
* @return String
*/
public String getLoadingMessage() {
return getAttributeAsString("loadingMessage");
}
/**
* The default setting of 'null' or 'fragment' indicates that HTML loaded from {@link
* com.smartgwt.client.widgets.HTMLFlow#getContentsURL contentsURL} is assumed to be an HTML fragment rather than a
* complete page. Set to "page" to load HTML as a standalone page, via an IFRAME. <P>
* <code>contentsType:"page"</code> should only be used for controlled HTML content, and only when such content
* cannot be delivered as an HTML fragment instead (the default). To dynamically load Smart GWT components, use
* {@link com.smartgwt.client.widgets.ViewLoader}, <b>never</b> this mechanism (click here for why). <P> Loading
* HTML content as a fragment is less resource intensive and avoids visual artifacts such as translucent media
* becoming opaque or disappearing when placed over an IFRAME. <P> Loading third-party, uncontrolled content could
* lead to the surrounding page disappearing if a user clicks on an HTML link with <code>target=_top</code>. <P>
* With <code>contentsType:"page"</code>, {@link com.smartgwt.client.widgets.HTMLFlow#getLoadingMessage
* loadingMessage} is not supported, and only "GET" is supported for {@link com.smartgwt.client.widgets.HTMLFlow#getHttpMethod
* httpMethod}.
*
* @param contentsType contentsType Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setContentsType(ContentsType contentsType) throws IllegalStateException {
setAttribute("contentsType", contentsType.getValue(), false);
}
/**
* The default setting of 'null' or 'fragment' indicates that HTML loaded from {@link
* com.smartgwt.client.widgets.HTMLFlow#getContentsURL contentsURL} is assumed to be an HTML fragment rather than a
* complete page. Set to "page" to load HTML as a standalone page, via an IFRAME. <P>
* <code>contentsType:"page"</code> should only be used for controlled HTML content, and only when such content
* cannot be delivered as an HTML fragment instead (the default). To dynamically load Smart GWT components, use
* {@link com.smartgwt.client.widgets.ViewLoader}, <b>never</b> this mechanism (click here for why). <P> Loading
* HTML content as a fragment is less resource intensive and avoids visual artifacts such as translucent media
* becoming opaque or disappearing when placed over an IFRAME. <P> Loading third-party, uncontrolled content could
* lead to the surrounding page disappearing if a user clicks on an HTML link with <code>target=_top</code>. <P>
* With <code>contentsType:"page"</code>, {@link com.smartgwt.client.widgets.HTMLFlow#getLoadingMessage
* loadingMessage} is not supported, and only "GET" is supported for {@link com.smartgwt.client.widgets.HTMLFlow#getHttpMethod
* httpMethod}.
*
* @return String
*/
public ContentsType getContentsType() {
return EnumUtil.getEnum(ContentsType.values(), getAttribute("contentsType"));
}
/**
* Parameters to be sent to the contentsURL when fetching content.
*
* @param contentsURLParams parameters
*/
public void setContentsURLParams(@SuppressWarnings("rawtypes") Map contentsURLParams) {
setAttribute("contentsURLParams", contentsURLParams, true);
}
@Override
@VaadinIntegration
public void paintContent(PaintTarget target) throws PaintException {
super.paintContent(target);
if (contentsResource != null) {
target.addAttribute("*contentsResource", contentsResource);
}
}
}