oracle.ord.html
Class OrdBuildURLRenderer

java.lang.Object
  |
  +--oracle.jdeveloper.html.HTMLFieldRendererImpl
        |
        +--oracle.ord.html.OrdBuildURLRenderer

All Implemented Interfaces:

oracle.jdeveloper.html.HTMLFieldRenderer, oracle.jdeveloper.html.HTMLRenderingContext

public class OrdBuildURLRenderer

extends oracle.jdeveloper.html.HTMLFieldRendererImpl

Generates an HTML tag string to render interMedia Business Component for Java (BC4J) domain objects in the browser.

OrdBuildURLRenderer serves as the default HTML display renderer class for all interMedia domain classes:

• OrdImageDomain
• OrdAudioDomain
• OrdVideoDomain
• OrdDocDomain

The HTML tag string generated by this class follows these rules:

• For OrdImageDomain domain objects: Generates HTML image tags, like <IMG SRC=[mediaFetchingURL] ALT=[attribute name] WIDTH=[width] HEIGHT=[height]>.
• For OrdAudioDomain, OrdVideoDomain, and OrdDocDomain domain objects: Generates HTML anchor tags, such as <A HREF=[mediaFetchingURL]>[attribute name]</A>.

Internally, OrdBuildURLRenderer class uses OrdURLBuilder class to build the [mediaFetchingURL] string.

Users can write their own HTML renderer class to create customized HTML tag strings for the interMedia domain classes. For example, users may prefer an HTML EMBED tag instead of an ANCHOR tag to render audio/video content. Or users may decide to add a JavaScript action to the generated HTML IMAGE tag. Use the class OrdURLBuilder to construct the [mediaFetchingURL] for the customized HTML renderer.

Since:

JDev3.2

See Also:

OrdURLBuilder

Constructor Summary

OrdBuildURLRenderer()
Constructor reserved for internal use.

OrdBuildURLRenderer(oracle.jbo.html.DataSource dataSource, oracle.jbo.Row row, java.lang.String attribute)
Deprecated.

Method Summary

int	getContentLength() Deprecated.
java.lang.Object	getOrdDomainObject() Deprecated.
java.lang.String	getOrdDomainURL() Deprecated.
boolean	isAudio() Deprecated.
boolean	isDoc() Deprecated.
boolean	isImage() Deprecated.
boolean	isNull() Deprecated.
boolean	isVideo() Deprecated.
java.lang.String	renderToString(oracle.jbo.Row row) Returns the HTML tag string that refers to the interMedia domain object.

Methods inherited from class oracle.jdeveloper.html.HTMLFieldRendererImpl

getAttributeDef, getCSSClassName, getDatasource, getDisplayHeight, getDisplayWidth, getFieldName, getFormName, getMaxDataLength, getPageContext, getPromptText, getValue, setAttributeDef, setCSSClassName, setDatasource, setDisplayHeight, setDisplayWidth, setFieldName, setFormName, setHtmlAttributes, setMaxDataLength, setPageContext, setPromptText, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

OrdBuildURLRenderer

public OrdBuildURLRenderer()

Constructor reserved for internal use. User should not use this constructor.

OrdBuildURLRenderer

public OrdBuildURLRenderer(oracle.jbo.html.DataSource dataSource,
                           oracle.jbo.Row row,
                           java.lang.String attribute)

Deprecated.

Constructs an HTML renderer.

Parameters:

dataSource - the object that contains data binding information used by the HTML renderer to access the domain object

row - the row which contains the interMedia domain object

attribute - the attribute for which to build the URL

Method Detail

getOrdDomainObject

public java.lang.Object getOrdDomainObject()

Deprecated.

Returns the interMedia domain object contained by the given attribute name in the given row. Returns null if there is no domain object in the row.

Returns:

the interMedia domain object contained by the given attribute name in the given row

isImage

public boolean isImage()

Deprecated.

Determines whether the domain object is an instance of OrdImageDomain. If the domain object is null, it returns false.

Returns:

true if the domain object is an instance of OrdImageDomain; otherwise, returns false

isAudio

public boolean isAudio()

Deprecated.

Determines whether the domain object is an instance of OrdAudioDomain. If the domain object is null, it returns false.

Returns:

true if the domain object is an instance of OrdAudioDomain; otherwise, returns false

isVideo

public boolean isVideo()

Deprecated.

Determines whether the domain object is an instance of OrdVideoDomain. If the domain object is null, it returns false.

Returns:

true if the domain object is an instance of OrdVideoDomain; otherwise, returns false

isDoc

public boolean isDoc()

Deprecated.

Determines whether the domain object is an instance of OrdDocDomain. If the domain object is null, it returns false.

Returns:

true if the domain object is an instance of OrdDocDomain; otherwise, returns false

isNull

public boolean isNull()

Deprecated.

Determines whether the domain object is null.

Returns:

true if the domain object is null; otherwise, returns false

getContentLength

public int getContentLength()

Deprecated.

Returns the content length of the interMedia domain object. If the domain object is null, it returns 0.

Returns:

the content length of the interMedia domain object

See Also:

OrdDomainIOInterface.getContentLength()

getOrdDomainURL

public java.lang.String getOrdDomainURL()

Deprecated.

Returns the URL string that points to the interMedia domain object. The URL string is used in the HTML tags generated by renderToString .

Returns:

the URL string

renderToString

public java.lang.String renderToString(oracle.jbo.Row row)

Returns the HTML tag string that refers to the interMedia domain object.

The HTML tags generated by this class follow these rules:

• For OrdImageDomain domain objects: Generates HTML image tags, like <IMG SRC=[URL] ALT=[attribute name] WIDTH=[width] HEIGHT=[height]>.
• For OrdAudioDomain, OrdVideoDomain, and OrdDocDomain domain objects: Generates HTML anchor tags, such as <A HREF=[URL]>[attribute name]</A>.

Certain BC4J data tags and data web beans call this method when they use the HTMLdisplay renderers to display a domain object in the browser.

Specified by:

renderToString in interface oracle.jdeveloper.html.HTMLFieldRenderer

Specified by:

renderToString in class oracle.jdeveloper.html.HTMLFieldRendererImpl

Parameters:

row - the row which contains the domain object

Returns:

the HTML tag string to locate the domain object