LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view.web.struts
Class LyStrutsFrame

java.lang.Object
  extended by leon.view.graphic.LyGraphicalObject
      extended by leon.view.web.LyWebObject
          extended by leon.view.web.LyWebPageWriter
              extended by leon.view.web.struts.LyStrutsView
                  extended by leon.view.web.struts.LyStrutsFrame
All Implemented Interfaces:
LyIsVisibleInterface, LyGraphicalComponent, LyGraphicalFrame, LyGraphicalView, LyViewComponent, LyFreeInterface, LySetLabelInterface, LySetVisibleInterface, LyWebComponent

public class LyStrutsFrame
extends LyStrutsView
implements LyGraphicalFrame, LyIsVisibleInterface, LySetVisibleInterface

Type : leon.view.web.struts.LyStrutsFrame
The peer component of LyFrame for the Struts viewer.


Field Summary
static java.lang.String __VERSION
           
static java.lang.String AREA
          The area String value used within frames names.
static java.lang.String MENUBAR
          The menubar String value used within frames names.
static java.lang.String MESSAGES
          The messages String value used within frames names.
 
Fields inherited from class leon.view.web.LyWebPageWriter
FORCE_AJAX, MAIN_BUFFER
 
Fields inherited from class leon.view.web.LyWebObject
WEB_COMPONENT_ID, WEB_CONTROLLER_ID, WEB_SESSION_ID
 
Constructor Summary
LyStrutsFrame(LyFrame frame)
          Constructor.
 
Method Summary
 void clearBeginScripts()
          (non-Javadoc).
 void clearCssScripts()
          (non-Javadoc).
 void clearEndScripts()
          (non-Javadoc).
 java.lang.String getFrameBaseUrl()
          Method overriden to set the IFRAME URL to the page action handler.
 java.lang.String getRedirect(java.lang.String frame)
          Gets the url for an alternate Web page.
 java.lang.String getTarget()
          (non-Javadoc).
 void init()
          Initialization method.
 boolean isFrameSet()
          (non-Javadoc).
 boolean isSuperVisible()
          Indicates if the component is visible or not.
 boolean isVisible()
          Indicates if the component is visible or not.
 void preparePage(java.lang.String frame, java.lang.String targetWindow)
          (non-Javadoc).
 void setBackgroundColor(java.lang.String hexColor, java.lang.String frame)
          Set the background color of the page and store the mapping between the color and frame.
 void setContent()
          Sets the content of the frame.
 void setMessages(LyMessages messages)
          Sets sub-component messages.
 void setProperty(java.lang.String name, java.lang.String value)
          (non-Javadoc).
 void setVisible(boolean status)
          Sets the visibility status of this component.
 void setVisibleStatus(boolean status)
          Force the visibility status of a Frame Internal use : may be used to prevent view from being cleared / freed.
 void writeBeginPage(java.io.Writer pw, java.lang.String frame)
          Writes the beginning of a HTML page (head, scripts and open the body).
 void writeEndPage(java.io.Writer pw, java.lang.String frame)
          Writes the end of HTML page.
 void writeMenuBar(LyWebPageWriter pw, java.lang.String targetWindow)
          Writes HTML description corresponding to the frame menubar.
 void writeMenuBar(LyWebPageWriter pw, java.lang.String frame, java.lang.String targetWindow)
          Writes HTML description corresponding to the frame menubar.
 void writeMessages(LyWebPageWriter pw)
          Writes HTML description corresponding to the frame messages.
 void writePageContent(java.io.Writer pw, java.lang.String frame)
          Writes the page content of the frame and the given writer.
 
Methods inherited from class leon.view.web.struts.LyStrutsView
getArea, getBuffer, getPageWriters, getView, setForceReloadState, setLabel, setNoFrames, setPrintMode, writeArea, writeHtml
 
Methods inherited from class leon.view.web.LyWebPageWriter
addBeginScript, addCssScript, addEndScript, addEndScript, append, clearBeginScripts, clearBuffer, clearCssScripts, clearEndScripts, copyScriptsTo, endComponent, free, getActionUrl, getActiveFormId, getActiveName, getAttachmentDirectory, getAttachmentHandler, getBackground, getBackgroundColor, getBeginScriptsAsHtml, getCssFileAsHtml, getCssScriptsAsHtml, getEndScriptsAsHtml, getForceReloadState, getFormId, getFrameName, getId, getLastReloadTime, getNextJavaScriptId, getOldIds, getOpenFormContent, getOpenFormContent, getProperty, getScriptRoot, getWindowName, isInnerView, isNoFrames, isPrintMode, setActiveBuffer, setAttachmentDirectory, setAttachmentDirectory, setAttachmentHandler, setAttachmentHandler, setBackground, setBodyClassName, setFormId, setFrameName, setInnerView, setLastModified, setTitle, setWindowName, setWriteDivOnly, startComponent, writeBeginScripts, writeCssScripts, writeDivOnly, writeEndScripts, writeHtml
 
Methods inherited from class leon.view.web.LyWebObject
addFileScript, decodeUrl, displayUpPage, encodeUrl, encodeUrlXhtml, expandUrl, getDisabledImageUrl, getFontSize, getFontString, getFontString, getFontString, getHexColor, getHexColor, getHtmlEntitiesString, getHtmlString, getImageSize, getImageSize, getImageUrl, getJavascriptString, getLastFrameName, getLyFont, getMessage, getRootUrl, getRootURL, getScrollHeightForSplitter, getUrl, getWebViewManager, refresh, replaceUrl, replaceUrl, setUpdating, updateRefreshInfo, writeJson
 
Methods inherited from class leon.view.graphic.LyGraphicalObject
expand, getBounds, getChildrenBounds, getController, getEnv, getEnvironment, getIdCode, getIntResource, getMessage, getResource, getString, getString, getString, getViewComponent, getViewManager, isFreed, isFreeing, isImageAnimated, processDemand, processDemand, testResource, translate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface leon.view.graphic.LyGraphicalFrame
setLabel
 
Methods inherited from interface leon.view.graphic.LyGraphicalComponent
free, getViewComponent
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values

MENUBAR

public static final java.lang.String MENUBAR
The menubar String value used within frames names.


AREA

public static final java.lang.String AREA
The area String value used within frames names.


MESSAGES

public static final java.lang.String MESSAGES
The messages String value used within frames names.

Constructor Detail

LyStrutsFrame

public LyStrutsFrame(LyFrame frame)
Constructor.

Parameters:
frame - the frame component
Method Detail

preparePage

public void preparePage(java.lang.String frame,
                        java.lang.String targetWindow)
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
preparePage in class LyWebPageWriter
See Also:
LyWebPageWriter.preparePage(java.lang.String, java.lang.String)

setVisible

public void setVisible(boolean status)
Description copied from interface: LySetVisibleInterface
Sets the visibility status of this component.

Specified by:
setVisible in interface LySetVisibleInterface
Overrides:
setVisible in class LyWebPageWriter
Parameters:
status - new visibility status, if true the component will be shown, if false it will be hiden

writeBeginPage

public void writeBeginPage(java.io.Writer pw,
                           java.lang.String frame)
                    throws java.io.IOException
Description copied from class: LyWebPageWriter
Writes the beginning of a HTML page (head, scripts and open the body).

Overrides:
writeBeginPage in class LyWebPageWriter
Parameters:
pw - the page writer
frame - the frame where the page is written
Throws:
java.io.IOException - if something is wrong during page writing

writePageContent

public void writePageContent(java.io.Writer pw,
                             java.lang.String frame)
                      throws java.io.IOException
Description copied from class: LyWebPageWriter
Writes the page content of the frame and the given writer.

Overrides:
writePageContent in class LyWebPageWriter
Parameters:
pw - the page writer
frame - the frame to write
Throws:
java.io.IOException

writeEndPage

public void writeEndPage(java.io.Writer pw,
                         java.lang.String frame)
                  throws java.io.IOException
Description copied from class: LyWebPageWriter
Writes the end of HTML page. Closes the body and html tags and the form tag if it exists.

Overrides:
writeEndPage in class LyWebPageWriter
Parameters:
pw - the page writer
frame - the frame where the page is written
Throws:
java.io.IOException - if something is wrong during end page writes

getFrameBaseUrl

public java.lang.String getFrameBaseUrl()
Method overriden to set the IFRAME URL to the page action handler.


setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
setProperty in class LyWebPageWriter
See Also:
LyWebPageWriter.setProperty(java.lang.String, java.lang.String)

init

public void init()
Initialization method. Overriden to add initialization of the visible status to false.

Overrides:
init in class LyWebPageWriter
See Also:
leon.view.web.LyWebPage#init()

setContent

public void setContent()
Sets the content of the frame.


setBackgroundColor

public void setBackgroundColor(java.lang.String hexColor,
                               java.lang.String frame)
Description copied from class: LyWebPageWriter
Set the background color of the page and store the mapping between the color and frame.

Overrides:
setBackgroundColor in class LyWebPageWriter
Parameters:
hexColor - the string that represents the hexadecimal code for the color
frame - the frame to associate to this background color
See Also:
LyWebPageWriter.getBackgroundColor(String)

getRedirect

public java.lang.String getRedirect(java.lang.String frame)
Description copied from class: LyWebPageWriter
Gets the url for an alternate Web page.

Specified by:
getRedirect in class LyWebPageWriter
Parameters:
frame - the frame to redirect
Returns:
the URL of the alternate Web page

clearBeginScripts

public void clearBeginScripts()
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
clearBeginScripts in class LyWebPageWriter
See Also:
LyWebPageWriter.clearBeginScripts()

clearEndScripts

public void clearEndScripts()
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
clearEndScripts in class LyWebPageWriter
See Also:
LyWebPageWriter.clearEndScripts()

clearCssScripts

public void clearCssScripts()
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
clearCssScripts in class LyWebPageWriter
See Also:
LyWebPageWriter.clearCssScripts()

isFrameSet

public boolean isFrameSet()
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
isFrameSet in class LyWebPageWriter
See Also:
LyWebPageWriter.isFrameSet()

setVisibleStatus

public void setVisibleStatus(boolean status)
Force the visibility status of a Frame Internal use : may be used to prevent view from being cleared / freed. Default value is false. This is not showing the view : see setVisible() instead.

Parameters:
status - the new status
See Also:
setVisible(boolean)

isVisible

public boolean isVisible()
Description copied from class: LyWebPageWriter
Indicates if the component is visible or not.

Specified by:
isVisible in interface LyIsVisibleInterface
Overrides:
isVisible in class LyWebPageWriter
Returns:
true if it is visible, false otherwise

isSuperVisible

public boolean isSuperVisible()
Indicates if the component is visible or not.

Returns:
true if the super component is shown (a visible component is never freed)
See Also:
leon.view.web.LyWebPage#isVisible()

getTarget

public java.lang.String getTarget()
Description copied from class: LyWebPageWriter
(non-Javadoc).

Overrides:
getTarget in class LyWebPageWriter
See Also:
LyWebPageWriter.getTarget()

writeMessages

public void writeMessages(LyWebPageWriter pw)
Writes HTML description corresponding to the frame messages.

Parameters:
pw - the page writer

writeMenuBar

public void writeMenuBar(LyWebPageWriter pw,
                         java.lang.String targetWindow)
Writes HTML description corresponding to the frame menubar.

Parameters:
pw - the page writer

writeMenuBar

public void writeMenuBar(LyWebPageWriter pw,
                         java.lang.String frame,
                         java.lang.String targetWindow)
Writes HTML description corresponding to the frame menubar.

Parameters:
pw - the page writer

setMessages

public void setMessages(LyMessages messages)
Description copied from interface: LyGraphicalFrame
Sets sub-component messages.

Specified by:
setMessages in interface LyGraphicalFrame
Parameters:
messages - New value of messages

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com