com.mathworks.toolbox.javabuilder.webfigures

Class WebFigureHtmlGenerator

java.lang.Object

com.mathworks.toolbox.javabuilder.webfigures.WebFigureHtmlGenerator

public class WebFigureHtmlGenerator
extends java.lang.Object

Utility class to get the HTML text required to display a webfigure on the viewer page

Constructor Summary

Constructors

Constructor and Description
WebFigureHtmlGenerator(HttpServletRequest servletRequest) Constructs a WebFigureHtmlGenerator instance from a URL reprsenting the WebFigure Servlet and servlet request.
WebFigureHtmlGenerator(HttpServletRequest servletRequest, HttpServletResponse response) Constructs WebFigureHtmlGenerator instance from servlet request and response
WebFigureHtmlGenerator(java.lang.String webFigureServletMappingName, HttpServletRequest servletRequest) Constructs a WebFigureHtmlGenerator instance from a URL reprsenting the WebFigure Servlet and servlet request.
WebFigureHtmlGenerator(java.lang.String webFigureServletMappingName, HttpServletRequest servletRequest, HttpServletResponse response)
WebFigureHtmlGenerator(java.lang.String appLocalRoot, ServletContext servletContext) Deprecated. Not for public use in the future. This method is found to return incorect values on some web servers.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFigureEmbedString(java.lang.String name, java.lang.String scope) This method gets an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(java.lang.String name, java.lang.String scope, java.lang.String style) This method gets an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(java.lang.String name, java.lang.String scope, java.lang.String width, java.lang.String height, java.lang.String style) This is the primary method of getting an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(WebFigure figure, java.lang.String name, java.lang.String scope) * This method gets an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(WebFigure figure, java.lang.String name, java.lang.String scope, java.lang.String style) This method gets an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(WebFigure figure, java.lang.String name, java.lang.String scope, java.lang.String width, java.lang.String height) This method gets an embed string for a WebFigure.
java.lang.String	getFigureEmbedString(WebFigure figure, java.lang.String name, java.lang.String scope, java.lang.String width, java.lang.String height, java.lang.String style) This method gets an embed string for a WebFigure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebFigureHtmlGenerator

public WebFigureHtmlGenerator(java.lang.String appLocalRoot,
                      ServletContext servletContext)

Deprecated. Not for public use in the future. This method is found to return incorect values on some web servers.

Constructs a WebFigureHtmlGenerator instance from a URL reprsenting the WebFigure Servlet and servlet context.

Parameters:

appLocalRoot - URL where the WebFigures service is mapped in the given ServletContext

servletContext - Reference to the servlet context for the current servlet

Throws:

java.net.MalformedURLException - if TODO

See Also:

WebFigureHtmlGenerator(String appLocalRoot, HttpServletRequest servletRequest)

WebFigureHtmlGenerator

public WebFigureHtmlGenerator(HttpServletRequest servletRequest)

Constructs a WebFigureHtmlGenerator instance from a URL reprsenting the WebFigure Servlet and servlet request.

Parameters:

servletRequest - Reference to the servlet request for the current servlet

Throws:

java.net.MalformedURLException - if TODO

WebFigureHtmlGenerator

public WebFigureHtmlGenerator(HttpServletRequest servletRequest,
                      HttpServletResponse response)

Constructs WebFigureHtmlGenerator instance from servlet request and response

Parameters:

servletRequest - Reference to the servlet request for the current servlet

response -

WebFigureHtmlGenerator

public WebFigureHtmlGenerator(java.lang.String webFigureServletMappingName,
                      HttpServletRequest servletRequest,
                      HttpServletResponse response)

Parameters:

webFigureServletMappingName - Reference to the name assigned to the webfigure servlet in the name mapping section of the web.xml usually this is WebFigures

servletRequest - Reference to the servlet request for the current servlet

response - Reference to the servlet response for the current servlet

WebFigureHtmlGenerator

public WebFigureHtmlGenerator(java.lang.String webFigureServletMappingName,
                      HttpServletRequest servletRequest)

Constructs a WebFigureHtmlGenerator instance from a URL reprsenting the WebFigure Servlet and servlet request.

Parameters:

webFigureServletMappingName - Reference to the name assigned to the webfigure servlet in the name mapping section of the web.xml usually this is WebFigures

servletRequest - Reference to the servlet request for the current servlet

Throws:

java.net.MalformedURLException - if TODO

Method Detail

getFigureEmbedString

public java.lang.String getFigureEmbedString(java.lang.String name,
                                    java.lang.String scope)
                                      throws MWException

This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. Height will default to 420 and Width will default to 560 for the iFrame and the iFrames default style will be used.

Parameters:

name -

scope -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(java.lang.String name,
                                    java.lang.String scope,
                                    java.lang.String style)
                                      throws MWException

This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. Height will default to 420 and Width will default to 560 for the iFrame If Style is null it the iFrame will just use its defaults.

Parameters:

name -

scope -

style -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(WebFigure figure,
                                    java.lang.String name,
                                    java.lang.String scope,
                                    java.lang.String width,
                                    java.lang.String height)
                                      throws MWException

This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. This will use the provided height and width if they are valid, else it will use the Figures height and width. This will use the iFrames defaults for style.

Parameters:

figure -

name -

scope -

width -

height -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(WebFigure figure,
                                    java.lang.String name,
                                    java.lang.String scope,
                                    java.lang.String width,
                                    java.lang.String height,
                                    java.lang.String style)
                                      throws MWException

This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. This will use the provided height and width if they are valid, else it will use the Figures height and width. If Style is null it the iFrame will just use its defaults.

Parameters:

figure -

name -

scope -

width -

height -

style -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(WebFigure figure,
                                    java.lang.String name,
                                    java.lang.String scope)
                                      throws MWException

* This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. This will use the Figures height and width. This will use the iFrames defaults for style.

Parameters:

figure -

name -

scope -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(WebFigure figure,
                                    java.lang.String name,
                                    java.lang.String scope,
                                    java.lang.String style)
                                      throws MWException

This method gets an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. This will use the Figures height and width. If Style is not passed in it the iFrame will just use its defaults.

Parameters:

figure -

name -

scope -

style -

Returns:

Throws:

MWException

getFigureEmbedString

public java.lang.String getFigureEmbedString(java.lang.String name,
                                    java.lang.String scope,
                                    java.lang.String width,
                                    java.lang.String height,
                                    java.lang.String style)
                                      throws MWException

This is the primary method of getting an embed string for a WebFigure. The name and scope must be provided or else an exception will be thrown. If the width or hieght are not passed in the width will default to 560 and height will default to 420. If Style is not passed in it the iFrame will just use its defaults.

Parameters:

name -

scope -

width -

height -

style -

Returns:

Throws:

MWException