e4s.html
Class IFRAME

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.html.E4HtmlElementGeneral
              e4s.html.E4HtmlElement
                  e4s.html.IFRAME

All Implemented Interfaces:

E4HtmlElement_Intf

public class IFRAME
extends E4HtmlElement
implements E4HtmlElement_Intf

IFRAME tag. Please notice, that the IFRAME tag might be incompatible using some browsers.

Since:

JDK 1.4

Field Summary

Fields inherited from class e4s.html.E4HtmlElementGeneral

m_elements, m_needed_scripts

Fields inherited from class e4s.html.E4HtmlObject

m_parent_e4sID

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

IFRAME(E4Method mref)
Construct a <IFRAME> element using the specified method to be executed within this frame.

IFRAME(E4Method mref, E4CgiParams params)
Construct a <IFRAME> element using the specified method to be executed within this frame, including some parameters.

IFRAME(java.lang.String url)
Construct a <IFRAME> element using the specified string as URL reference to be displayed.

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
E4Method	getE4Method() Deprecated. Use getMethod() instead
E4Method	getMethod() Get the method, if defined.
E4FrameName	getName() get the frame name for the IFRAME element.
java.lang.String	getUrl() Get the url, if defined.
void	setAlign(Align align) Set the horizontal align.
void	setFrameBorder(boolean border) Define, if a frame border is displayed.
void	setHeight(float height) Set the height in pixel.
void	setHeight(int height) Set the height in pixel.
void	setHeightMax() Set the maximum height (100%).
void	setId(java.lang.String id)
void	setMarginHeight(int marginheight) Set the margin height.
void	setMarginWidth(int marginwidth) Set the margin width.
void	setName(E4FrameName name) Set the frame name for the IFRAME element.
void	setScrolling_Auto() Define, the scrolling behavior to auto scrolling.
void	setScrolling_No() Define, the scrolling behavior to no scrolling.
void	setScrolling_Yes() Define, the scrolling behavior to scrolling enabled.
void	setWidth(float width) Set the width in percentage.
void	setWidth(int width) Set the width in pixel.
void	setWidthMax() Set the maximum width (100%).
void	toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) Create the HTML output for this element.
java.lang.String	toString()

Methods inherited from class e4s.html.E4HtmlElement

addElement, addElement, addElement, copyElements, print

Methods inherited from class e4s.html.E4HtmlElementGeneral

addScript, addScript, addScript, addStyleForEditing, addTranslationForEditing, buildStyleAttribute, buildStyleClassReference, collectScripts, collectStylesForEditing, collectStylesForEditing, collectStylesForEditing, collectTranslationsForEditing, collectTranslationsForEditing, createScript, createScript, debugToString, findElement, findElement, findElement, findElement, getElements, getElementsVec, getField, getId, getLastElement, getStringContent, getStyle, getSTYLE, getStyle, hasScripts, hasSTYLE, isContentClass, isE4InputField_Intf, openTag, removeAll, removeElementById, removeElements, removeElements, removeStyle, setId, setReadOnly, setStyle, setStyle, setSTYLE, setValue, Style, Style, toHtml_hidden, validate

Methods inherited from class e4s.html.E4HtmlObject

E4ID, E4ID, set_e4sID

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface e4s.html.E4HtmlElement_Intf

addScript, addScript, addScript, collectScripts, collectStylesForEditing, collectTranslationsForEditing, debugToString, findElement, findElement, getElements, getElementsVec, getField, getId, getStringContent, isContentClass, removeAll, removeElementById, removeElements, set_e4sID, setId, setReadOnly, setValue, toHtml_hidden, validate

Constructor Detail

IFRAME

public IFRAME(java.lang.String url)

Construct a <IFRAME> element using the specified string as URL reference to be displayed.

Parameters:

url - the url (HTML page) to be displayed, e.g. "http://www.google.de"

See Also:

getUrl()

IFRAME

public IFRAME(E4Method mref)

Construct a <IFRAME> element using the specified method to be executed within this frame.

Parameters:

mref - the method to be called

See Also:

IFRAME( E4Method, E4CgiParams ), getE4Method()

IFRAME

public IFRAME(E4Method mref,
              E4CgiParams params)

Construct a <IFRAME> element using the specified method to be executed within this frame, including some parameters.

Parameters:

mref - the method to be called

params - additional parameters, can be null

See Also:

IFRAME( E4Method )

Method Detail

toHtml

public void toHtml(E4StringBufferHtml buf,
                   E4ServletImplementation_Intf servlet)
            throws java.lang.Exception

Description copied from interface: E4HtmlElement_Intf

Create the HTML output for this element. Also run throught all child elements, and call their E4HtmlElement_Intf.toHtml(e4s.util.E4StringBufferHtml, e4s.servlet.E4ServletImplementation_Intf) function to generate output of those objects which becomes appended. Normally, there is no need to call this function anyway, and this also might result in side effects of too-early relasing of objects in some cases. This function is called by E4ServletImplementation_Intf.write(e4s.html.E4HtmlElement) on the top level HTML element (common this is a HTML or BODY element) and branches down to all child elements.

Specified by:

toHtml in interface E4HtmlElement_Intf

Overrides:

toHtml in class E4HtmlElementGeneral

Parameters:

servlet - is the servlet context which can be retrieved using the E4ModuleImplementation.getServlet().

Throws:

java.lang.Exception

setWidth

public void setWidth(int width)

Set the width in pixel.

Parameters:

width - width in pixel, a value of -1 means that no width shall be specified in the tag

See Also:

setHeight(int), setWidthMax(), setWidth(float)

setWidthMax

public void setWidthMax()

Set the maximum width (100%).

See Also:

setHeightMax(), setWidth(int), setWidth(float)

setWidth

public void setWidth(float width)

Set the width in percentage.

Parameters:

width - width in percentage, a value in the range between 0.0f and 1.0f

See Also:

setHeight(float), setWidthMax(), setWidth(int)

setHeight

public void setHeight(int height)

Set the height in pixel.

Parameters:

height - width in pixel, a value of -1 means that no height shall be specified in the tag

See Also:

setWidth(int), setHeightMax(), setHeight(float)

setHeightMax

public void setHeightMax()

Set the maximum height (100%).

See Also:

setWidthMax(), setHeight(int), setHeight(float)

setHeight

public void setHeight(float height)

Set the height in pixel.

Parameters:

height - width in percentage, a value in the range between 0.0f and 1.0f

See Also:

setWidth(int), setHeightMax(), setHeight(int)

setName

public void setName(E4FrameName name)

Set the frame name for the IFRAME element.

Parameters:

name - the frame name

See Also:

getName()

setAlign

public void setAlign(Align align)

Set the horizontal align.

Parameters:

align - one of Align.ALIGN_LEFT, Align.ALIGN_CENTER or Align.ALIGN_RIGHT

setMarginWidth

public void setMarginWidth(int marginwidth)

Set the margin width.

Parameters:

marginwidth - margin width in pixel, a value of -1 indicates no marginwidth element within the tag.

See Also:

setMarginHeight(int)

setMarginHeight

public void setMarginHeight(int marginheight)

Set the margin height.

Parameters:

marginheight - margin heightin pixel, a value of -1 indicates no marginhight element within the tag.

See Also:

setMarginWidth(int)

setFrameBorder

public void setFrameBorder(boolean border)

Define, if a frame border is displayed.

Parameters:

border - true: display a border (default value), false: no border

setScrolling_No

public void setScrolling_No()

Define, the scrolling behavior to no scrolling.

See Also:

#e4s.html.FRAME#NO_SCROLLING

setScrolling_Yes

public void setScrolling_Yes()

Define, the scrolling behavior to scrolling enabled.

See Also:

#e4s.html.FRAME#ENABLE_SCROLLING

setScrolling_Auto

public void setScrolling_Auto()

Define, the scrolling behavior to auto scrolling.

See Also:

#e4s.html.FRAME#AUTO_SCROLLING

getUrl

public java.lang.String getUrl()

Get the url, if defined.

Returns:

null if no url was defined or the url.

See Also:

IFRAME(String)

getE4Method

public E4Method getE4Method()

Deprecated. Use getMethod() instead

getMethod

public E4Method getMethod()

Get the method, if defined.

Returns:

null if no method was defined or the method.

See Also:

IFRAME(E4Method), IFRAME(E4Method,E4CgiParams)

getName

public E4FrameName getName()

get the frame name for the IFRAME element.

Returns:

the frame name

See Also:

setName(e4s.html.E4FrameName)

toString

public java.lang.String toString()

Overrides:

toString in class E4Object

setId

public void setId(java.lang.String id)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)