e4s.html
Class FRAME

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.html.E4HtmlElementGeneral
              e4s.html.E4HtmlElement
                  e4s.html.E4HtmlContentElement
                      e4s.html.E4HtmlContentElementPersistant
                          e4s.html.BODY
                              e4s.html.HTML
                                  e4s.html.FRAME

All Implemented Interfaces:

E4HtmlElement_Intf

public class FRAME
extends HTML

HTML: Creates a <FRAME>-tag. The FRAME class is very tight related to the FRAMESET class but from it's behaviour a HTML page. Note, that in the E4S environment you can create a frame, and immediatly write into that frame. A typical creation of a FRAME might look like this:

Example_Frames.java

Since:

JDK 1.4

See Also:

E4FrameName, FRAMESET, E4EditingFrameset

Nested Class Summary

Nested classes/interfaces inherited from class e4s.html.HTML

HTML.E4HtmlMetaTags

Field Summary

static java.lang.String	_SCRIPT_GETFRAMENAME This is the name of the associated Java Script function to get the name of this frame.
static int	AUTO_SCROLLING Deprecated. Use SCROLLING_AUTO instead
static int	ENABLE_SCROLLING Deprecated. Use SCROLLING_ENABLED instead
static int	NO_SCROLLING Deprecated. Use SCROLLING_NONE instead
static int	SCROLLING_AUTO Define the scrolling state of a frame: scrolling=auto.
static int	SCROLLING_ENABLED Define the scrolling state of a frame: scrolling=yes.
static int	SCROLLING_NONE Define the scrolling state of a frame: scrolling=no.

Fields inherited from class e4s.html.HTML

JS_SERVLET_PRESERVED_REQUEST, JS_SERVLET_REQUEST

Fields inherited from class e4s.html.BODY

DEFAULTSTYLE, HTML_TAG

Fields inherited from class e4s.html.E4HtmlContentElement

BOOL_STR_FALSE, BOOL_STR_TRUE

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

FRAME(E4ID parent_id, E4FrameName name, float size)
Constructor for the FRAME.

FRAME(E4ID parent_id, E4FrameName name, float size, boolean scrolling)
Deprecated.

FRAME(E4ID parent_id, E4FrameName name, float size, int scrolling)
Constructor for the FRAME.

FRAME(E4ID parent_id, E4FrameName name, long size)
Constructor for the FRAME.

FRAME(E4ID parent_id, E4FrameName name, long size, int scrolling)
Constructor for the FRAME.

FRAME(E4ID parent_id, E4FrameName name, java.lang.String size)
Constructor for the FRAME.

FRAME(E4ID parent_id, E4FrameName name, java.lang.String size, boolean scrolling)
Deprecated.

FRAME(E4ID parent_id, E4FrameName name, java.lang.String size, int scrolling)
Constructor for the FRAME.

FRAME(E4ID parent_id, float size)
Constructor for the FRAME, uses an generic name.

FRAME(E4ID parent_id, float size, boolean scrolling)
Deprecated.

FRAME(E4ID parent_id, float size, int scrolling)
Constructor for the FRAME, uses a generic name.

FRAME(E4ID parent_id, int size, int scrolling)
Constructor for the FRAME, uses a generic name.

FRAME(E4ID parent_id, long size)
Constructor for the FRAME, uses an generic name.

FRAME(E4ID parent_id, java.lang.String size)
Constructor for the FRAME, uses an generic name.

FRAME(E4ID parent_id, java.lang.String size, boolean scrolling)
Deprecated.

FRAME(E4ID parent_id, java.lang.String size, int scrolling)
Constructor for the FRAME, uses a generic name.

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
void	collectStylesForEditing(E4StylesHash v, E4ServletImplementation_Intf servlet) Build a list (Vector) with style definitions used so far during display of this page.
java.lang.String	constructUrl(E4ServletImplementation_Intf servlet)
E4ID	E4ID() Get the E4ID of the object.
boolean	getBorder() Get the resizing state of the frame.
E4FrameName	getFrameName() Get the frame name.
java.lang.String	getFrameSize() Get the frame size.
int	getMarginHeight() Get the margin height for this frame.
int	getMarginWidth() Get the margin width for this frame.
static java.lang.String	getPersistantParamName_FrameSize(E4FrameName framename) Persistant name of the parameter for the frame width.
static java.lang.String	getPersistantParamName_FrameSize(java.lang.String framename) Persistant name of the parameter for the frame width.
boolean	getResize() Get the resizing state of the frame.
protected void	init(E4FrameName name, java.lang.String size, int scrolling)
int	isScrolling() Get the scrolling state.
boolean	isUrl() Check, if an URL or if an E4Method link is defined.
java.lang.String	scrollingToString() Get the scrolling state.
void	setBorder(boolean mode) Define, if a frame border shall be displayed.
void	setFrameSize(int size) Changes the frame size.
void	setFrameSize(java.lang.String size) Changes the frame size.
void	setMarginHeight(int height) Set the margin height for this frame.
void	setMarginWidth(int width) Set the margin width for this frame.
void	setResize(boolean mode) Enables resizing of the frame.
void	setScrolling_Auto()
void	setScrolling_No()
void	setScrolling_Yes()
void	setScrolling(int mode) Define the scrolling mode for the frame.
void	setSTYLE(CLASS_Name classname)
void	setUrl(E4Method mref)
void	setUrl(E4Method mref, E4CgiParams params)
void	setUrl(java.lang.String url)
java.lang.String	toHtml(java.lang.String url)

Methods inherited from class e4s.html.HTML

BODY, collectTranslationsForEditing, displayWaitAndForward, E4SubEditingBODY, E4SubEditingBODY, enableUTF8, FieldsetTabbed, FRAMESET, FRAMESET, getIcon, getLocalCSS, getMetaTags, getTitle, isUTF8enabled, MenuFrameset, MenuFrameset, preventStyleEditing, preventTranslationEditing, setDefaultIcon, setDefaultTitle, setDefaultTitle, setDefaultTitle, setIcon, setLocalCSS, setMetaTag, setStrict, setTitle, setTitle, setTitle, toHtml, toHtml

Methods inherited from class e4s.html.BODY

A_Name, A_Name, A_Name, A_Name, A_Name, addKeepAliveScript, BlockMenuElement, createEventHandler, createEventHandler, defineNoScript, E4DropDownMenu, E4DropDownMenu, eventHandlers, FIELDSET, FieldsetTable, FORM, FORM, FORM, FORM, FullSizeE4Message, getBgColor, getBgImage, getEventHandlers, IFRAME, IFRAME, IFRAME, MenuElement, MenuElement, MenuElement, MethodInlineElement, MethodInlineElement, NOSCIPT, onLoad_Print, onLoad, onLoad, onLoad, onResize, onUnLoad, onUnLoad, redirectLocation, redirectLocation, setBgcolor, setBgColor, setBgImage, setCodeBeforeClosing, setEventHandler, setStatusBar, SortedListElement, SortedListElement, toHtml_without_BodyTag, TreeElement, TreeElement

Methods inherited from class e4s.html.E4HtmlContentElementPersistant

preventFromRemoving, preventFromRemoving, removeAll, toDebug

Methods inherited from class e4s.html.E4HtmlContentElement

A_Email, A_Email, A_Multiple, A_Popup, A_Popup, A_Popup, A_Popup, A_Popup, A_Popup, A_Popup, A_Reference, A_Reference, A_Reference, A_Reference, A_Reference, A_ReturnValue, A_ReturnValue, A_ReturnValue, A_ReturnValue, A, A, A, A, A, A, A, AjaxElement, AjaxElement, AjaxElement, B, B, BIG, Box, Box, Box, BoxRoundCorners, BoxRoundCorners, BoxRoundCorners, BR, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, BUTTON, CENTER, DEL, DIV, DIV, DIV, DIV, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FONT, FullSizeE4Message, H1, H2, H3, H4, Hint, HR, I, I, IMG, IMG, IMG, IMG, IMG, IMG, IMG, IMG, INS, Message, Message, Message, Message, Message, NBSP, NOBR, P_NBSP, P, PRE, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, rem, rem, rem, rem, rem, rem, SMALL, SPAN, STRIKE, strike, SystemError, SystemError, SystemError, SystemError, TABLE, TABLE, trace, trace, trace, trace, trace, trace, translate_Sys, translate, U, UL

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, collectTranslationsForEditing, createScript, createScript, debugToString, findElement, findElement, findElement, findElement, getElements, getElementsVec, getField, getId, getLastElement, getStringContent, getStyle, getSTYLE, getStyle, hasScripts, hasSTYLE, isContentClass, isE4InputField_Intf, openTag, removeElementById, removeElements, removeElements, removeStyle, setId, setReadOnly, setStyle, setStyle, setSTYLE, setValue, Style, Style, toHtml_hidden, validate

Methods inherited from class e4s.html.E4HtmlObject

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, toDouble, toFloat, toFloat, toString, 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, debugToString, findElement, findElement, getElements, getElementsVec, getField, getId, getStringContent, isContentClass, removeAll, removeElementById, removeElements, set_e4sID, setId, setReadOnly, setValue, toHtml_hidden, validate

Field Detail

SCROLLING_NONE

public static final int SCROLLING_NONE

Define the scrolling state of a frame: scrolling=no.

See Also:

SCROLLING_ENABLED, SCROLLING_AUTO, Constant Field Values

NO_SCROLLING

public static final int NO_SCROLLING

Deprecated. Use SCROLLING_NONE instead

See Also:

Constant Field Values

SCROLLING_ENABLED

public static final int SCROLLING_ENABLED

Define the scrolling state of a frame: scrolling=yes.

See Also:

SCROLLING_NONE, SCROLLING_AUTO, isScrolling(), Constant Field Values

ENABLE_SCROLLING

public static final int ENABLE_SCROLLING

Deprecated. Use SCROLLING_ENABLED instead

See Also:

Constant Field Values

SCROLLING_AUTO

public static final int SCROLLING_AUTO

Define the scrolling state of a frame: scrolling=auto.

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, isScrolling(), Constant Field Values

AUTO_SCROLLING

public static final int AUTO_SCROLLING

Deprecated. Use SCROLLING_AUTO instead

See Also:

Constant Field Values

_SCRIPT_GETFRAMENAME

public static final java.lang.String _SCRIPT_GETFRAMENAME

This is the name of the associated Java Script function to get the name of this frame.

See Also:

Constant Field Values

Constructor Detail

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             java.lang.String size)

Constructor for the FRAME.

Parameters:

name - name of the frame, used in the tag (see getFrameName())

size - size in pixel or percentage of the frame (see getFrameSize())

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             float size)

Constructor for the FRAME.

Parameters:

name - name of the frame, used in the tag (see getFrameName())

size - size in pixel or percentage of the frame (see getFrameSize())

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             long size)

Constructor for the FRAME.

Parameters:

name - name of the frame, used in the tag (see getFrameName())

size - size in pixel or percentage of the frame (see getFrameSize())

FRAME

public FRAME(E4ID parent_id,
             java.lang.String size)

Constructor for the FRAME, uses an generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

See Also:

E4FrameName.ANY()

FRAME

public FRAME(E4ID parent_id,
             long size)

Constructor for the FRAME, uses an generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

See Also:

E4FrameName.ANY()

FRAME

public FRAME(E4ID parent_id,
             float size)

Constructor for the FRAME, uses an generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

See Also:

E4FrameName.ANY()

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             java.lang.String size,
             boolean scrolling)

Deprecated.

FRAME

public FRAME(E4ID parent_id,
             java.lang.String size,
             boolean scrolling)

Deprecated.

See Also:

FRAME(E4ID,String,int)

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             java.lang.String size,
             int scrolling)

Constructor for the FRAME.

Parameters:

name - name of the frame, used in the tag (see getFrameName())

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling()

FRAME

public FRAME(E4ID parent_id,
             java.lang.String size,
             int scrolling)

Constructor for the FRAME, uses a generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling(), E4FrameName.ANY()

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             float size,
             int scrolling)

Constructor for the FRAME.

Parameters:

name - name of the frame, used in the tag (see getFrameName())

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling()

FRAME

public FRAME(E4ID parent_id,
             float size,
             int scrolling)

Constructor for the FRAME, uses a generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling(), E4FrameName.ANY()

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             float size,
             boolean scrolling)

Deprecated.

FRAME

public FRAME(E4ID parent_id,
             float size,
             boolean scrolling)

Deprecated.

FRAME

public FRAME(E4ID parent_id,
             E4FrameName name,
             long size,
             int scrolling)

Constructor for the FRAME.

Parameters:

name - the name of the frame

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling()

FRAME

public FRAME(E4ID parent_id,
             int size,
             int scrolling)

Constructor for the FRAME, uses a generic name.

Parameters:

size - size in pixel or percentage of the frame (see getFrameSize())

scrolling - defines, if scrolling is enabled or not (see isScrolling()

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling(), E4FrameName.ANY()

Method Detail

init

protected void init(E4FrameName name,
                    java.lang.String size,
                    int scrolling)

setResize

public void setResize(boolean mode)

Enables resizing of the frame. Resizing is enabled by default.

Parameters:

mode - true=enable resize

See Also:

getResize()

getResize

public boolean getResize()

Get the resizing state of the frame.

Returns:

true if resizing is enabled

See Also:

setResize(boolean)

setBorder

public void setBorder(boolean mode)

Define, if a frame border shall be displayed. Displaying a border is enabled by default.

Parameters:

mode - true=display border

See Also:

getBorder()

getBorder

public boolean getBorder()

Get the resizing state of the frame.

Returns:

true if resizing is enabled

See Also:

setBorder(boolean)

setMarginWidth

public void setMarginWidth(int width)

Set the margin width for this frame.

Parameters:

width - width in pixel, a value of -1 uses the browser default

See Also:

setMarginHeight(int), getMarginWidth()

getMarginWidth

public int getMarginWidth()

Get the margin width for this frame.

Returns:

width in pixel, a value of -1 uses the browser default

See Also:

setMarginWidth(int), getMarginHeight()

setMarginHeight

public void setMarginHeight(int height)

Set the margin height for this frame.

Parameters:

margin - height in pixel, a value of -1 uses the browser default

See Also:

setMarginWidth(int), getMarginHeight()

getMarginHeight

public int getMarginHeight()

Get the margin height for this frame.

Returns:

height in pixel, a value of -1 uses the browser default

See Also:

setMarginHeight(int), getMarginWidth()

setScrolling

public void setScrolling(int mode)

Define the scrolling mode for the frame. This attribute normally can be set within the constructor.

Parameters:

mode - (one of SCROLLING_NONE, SCROLLING_ENABLED or SCROLLING_AUTO)

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, isScrolling(), scrollingToString()

setScrolling_No

public void setScrolling_No()

setScrolling_Yes

public void setScrolling_Yes()

setScrolling_Auto

public void setScrolling_Auto()

setUrl

public void setUrl(java.lang.String url)

setUrl

public void setUrl(E4Method mref)

setUrl

public void setUrl(E4Method mref,
                   E4CgiParams params)

getFrameSize

public java.lang.String getFrameSize()

Get the frame size. This is a String value, but is in the form "n" or "n%" and used within the tag.

Returns:

the size as defined by constructor.

setFrameSize

public void setFrameSize(java.lang.String size)

Changes the frame size. Normally, the fram size is defined on initialization, this function enables change of unpainted frames.

Parameters:

size - the new frame size

See Also:

getFrameSize()

setFrameSize

public void setFrameSize(int size)

Changes the frame size. Normally, the fram size is defined on initialization, this function enables change of unpainted frames.

Parameters:

size - the new frame size

See Also:

getFrameSize()

getFrameName

public E4FrameName getFrameName()

Get the frame name.

Returns:

the name as defined by constructor.

isScrolling

public int isScrolling()

Get the scrolling state.

Returns:

the state of scrolling (one of SCROLLING_NONE, SCROLLING_ENABLED or SCROLLING_AUTO)

See Also:

SCROLLING_NONE, SCROLLING_ENABLED, SCROLLING_AUTO, scrollingToString(), setScrolling(int)

scrollingToString

public java.lang.String scrollingToString()

Get the scrolling state.

Returns:

the state of scrolling (one of "NO" for SCROLLING_NONE, "YES" for SCROLLING_ENABLED or "AUTO" for SCROLLING_AUTO)

See Also:

isScrolling()

isUrl

public boolean isUrl()

Check, if an URL or if an E4Method link is defined.

Returns:

true, if either the url or E4Method is defined.

See Also:

constructUrl(E4ServletImplementation_Intf)

constructUrl

public java.lang.String constructUrl(E4ServletImplementation_Intf servlet)

getPersistantParamName_FrameSize

public static java.lang.String getPersistantParamName_FrameSize(E4FrameName framename)

Persistant name of the parameter for the frame width. When frame width shall be persistant, it is important to define a parameter that is unique for each frame name. It is recommended, that in the application different frame names are used, otherwise they all become assigned the same width.

Parameters:

framename - name of the frame

Returns:

this is not the value of the width, just the name of the parameter to be used by E4ServletImplementation_Intf.getPersistantParameter(String). A value of null is returned in the case that framename == null.

getPersistantParamName_FrameSize

public static java.lang.String getPersistantParamName_FrameSize(java.lang.String framename)

Persistant name of the parameter for the frame width. When frame width shall be persistant, it is important to define a parameter that is unique for each frame name. It is recommended, that in the application different frame names are used, otherwise they all become assigned the same width.

Parameters:

framename - name of the frame

Returns:

this is not the value of the width, just the name of the parameter to be used by E4ServletImplementation_Intf.getPersistantParameter(String). A value of null is returned in the case that framename == null.

toHtml

public java.lang.String toHtml(java.lang.String url)

E4ID

public E4ID E4ID()

Description copied from class: E4HtmlObject

Get the E4ID of the object. The E4ID is a unique identifier for an nested HTML element, it can be either the name of the class or any previous assigned string.

Overrides:

E4ID in class E4HtmlObject

Returns:

the E4ID

See Also:

E4HtmlObject.E4ID(String), E4HtmlObject.set_e4sID(e4s.util.E4ID)

setSTYLE

public void setSTYLE(CLASS_Name classname)

Overrides:

setSTYLE in class BODY

collectStylesForEditing

public void collectStylesForEditing(E4StylesHash v,
                                    E4ServletImplementation_Intf servlet)

Description copied from class: E4HtmlElementGeneral

Build a list (Vector) with style definitions used so far during display of this page. Run throught all subclasses elements and collect their styles as well. Note, that a style will only be added one time. The Vector contains elements of class E4StyleUsage.

Specified by:

collectStylesForEditing in interface E4HtmlElement_Intf

Overrides:

collectStylesForEditing in class E4HtmlElementGeneral

Parameters:

v - the Vector where the styles will be collected, may not be null

servlet - the servlet context

See Also:

E4ServletImplementation_Intf.sessionCanEditStyles(), #collectStylesForEditing(e4s.html.style.E4StylesHash, STYLE_Name, boolean)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)