|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.view.graphic.LyGraphicalObject
leon.view.web.LyWebObject
leon.view.web.LyWebPageWriter
public abstract class LyWebPageWriter
It must be inherited in order to generate HTML pages.
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static boolean |
FORCE_AJAX
Indicates whether Ajax mode must be forced in every page. |
static java.lang.String |
MAIN_BUFFER
The main buffer name. |
Fields inherited from class leon.view.web.LyWebObject |
---|
WEB_COMPONENT_ID, WEB_CONTROLLER_ID, WEB_SESSION_ID |
Constructor Summary | |
---|---|
LyWebPageWriter(LyComponent component)
Constructor. |
Method Summary | |
---|---|
void |
addBeginScript(java.lang.String text,
boolean isFile)
(non-Javadoc). |
void |
addCssScript(java.lang.String text,
boolean isFile)
(non-Javadoc). |
void |
addEndScript(java.lang.String text,
boolean isFile)
(non-Javadoc). |
void |
addEndScript(java.lang.String text,
boolean isFile,
boolean insertEnd)
(non-Javadoc). |
void |
append(java.lang.String string)
(non-Javadoc). |
void |
clearBeginScripts()
(non-Javadoc). |
void |
clearBeginScripts(java.lang.String name)
Clears the begin scripts of the given frame. |
void |
clearBuffer(java.lang.String name)
(non-Javadoc). |
void |
clearCssScripts()
(non-Javadoc). |
void |
clearCssScripts(java.lang.String name)
Clears all CSS scripts of the given frame. |
void |
clearEndScripts()
(non-Javadoc). |
void |
clearEndScripts(java.lang.String name)
Clears the end scripts of the given frame. |
void |
copyScriptsTo(LyWebPageWriter pw)
Copy Begin, End and CSS scripts to the specified page writer. |
void |
endComponent(LyWebObject webObject)
End writing of given component. |
void |
free()
(non-Javadoc). |
java.lang.String |
getActionUrl()
Builds the URL of the action attribute of the
<FORM> HTML tag. |
java.lang.String |
getActiveFormId()
Implementation of LyWebPageWriter. |
java.lang.String |
getActiveName()
(non-Javadoc). |
java.lang.String |
getAttachmentDirectory(java.lang.String key)
(non-Javadoc). |
java.lang.String |
getAttachmentHandler(java.lang.String key)
(non-Javadoc). |
java.lang.String |
getBackground()
Gets the background motif of the page. |
java.lang.String |
getBackgroundColor(java.lang.String frame)
Gets the background color of the given frame. |
java.lang.StringBuffer |
getBeginScriptsAsHtml(java.lang.String frame)
Gets a StringBuffer that contains the HTML for the begin scripts associated to the given frame. |
java.lang.StringBuffer |
getBuffer(java.lang.String frame)
Gets the buffer associated to the given frame. |
java.lang.StringBuffer |
getCssFileAsHtml(java.lang.String frame)
Gets the HTML code corresponding to a CSS file style sheet declaration of the given frame. |
java.lang.StringBuffer |
getCssScriptsAsHtml(java.lang.String frame,
boolean file)
Gets a StringBuffer that contains the HTML code of the given frame CSS scripts. |
java.lang.StringBuffer |
getEndScriptsAsHtml(java.lang.String frame)
Gets a StringBuffer that contains the HTML for the end scripts associated to the given frame. |
boolean |
getForceReloadState()
(non-Javadoc). |
java.lang.String |
getFormId(java.lang.String frame)
Gets the formId associated to the given frame. |
java.lang.String |
getFrameName()
(non-Javadoc). |
java.lang.String |
getId()
(non-Javadoc). |
long |
getLastReloadTime()
(non-Javadoc). |
long |
getNextJavaScriptId()
(non-Javadoc). |
java.util.Vector<java.lang.String> |
getOldIds()
(non-Javadoc). |
java.lang.String |
getOpenFormContent(java.lang.String frame)
Writes the open form tag of the frame and the given writer. |
java.lang.String |
getOpenFormContent(java.lang.String frame,
boolean force)
Writes the open form tag of the frame and the given writer. |
abstract java.util.Vector<LyWebPageWriter> |
getPageWriters()
(non-Javadoc). |
java.lang.String |
getProperty(java.lang.String name)
(non-Javadoc). |
abstract java.lang.String |
getRedirect(java.lang.String frame)
Gets the url for an alternate Web page. |
java.lang.String |
getScriptRoot()
Gets the script root path of the page. |
java.lang.String |
getTarget()
(non-Javadoc). |
java.lang.String |
getWindowName()
(non-Javadoc). |
void |
init()
Initialization method. |
boolean |
isFrameSet()
(non-Javadoc). |
boolean |
isInnerView()
(non-Javadoc). |
boolean |
isNoFrames()
Indicates if frameset are used or not. |
boolean |
isPrintMode()
(non-Javadoc). |
boolean |
isVisible()
Indicates if the component is visible or not. |
void |
preparePage(java.lang.String frame,
java.lang.String targetWindow)
(non-Javadoc). |
void |
setActiveBuffer(java.lang.String name)
(non-Javadoc). |
void |
setAttachmentDirectory(java.lang.String attachmentDirectory)
Accessor to the attachment handler directory. |
void |
setAttachmentDirectory(java.lang.String key,
java.lang.String attachmentDirectory)
Accessor to the attachment handler directory. |
void |
setAttachmentHandler(java.lang.String attachmentHandler)
Accessor to the attachment handler. |
void |
setAttachmentHandler(java.lang.String key,
java.lang.String attachmentHandler)
Accessor to the attachment handler. |
void |
setBackground(java.lang.String image)
Sets the background motif of the page. |
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 |
setBodyClassName(java.lang.String bodyClassName)
Sets the name of the CSS class to be used for body tag. |
void |
setForceReloadState(boolean force)
(non-Javadoc). |
void |
setFormId(java.lang.String formId)
(non-Javadoc). |
void |
setFrameName(java.lang.String name)
(non-Javadoc). |
void |
setInnerView(boolean innerView)
(non-Javadoc). |
void |
setLastModified(LyViewManager viewManager,
long lastModified)
(non-Javadoc). |
void |
setNoFrames(boolean noFrames)
Prevent from using frameset. |
void |
setPrintMode(boolean printMode)
(non-Javadoc). |
void |
setProperty(java.lang.String name,
java.lang.String value)
(non-Javadoc). |
void |
setTitle(java.lang.String title)
(non-Javadoc). |
void |
setVisible(boolean status)
|
void |
setWindowName(java.lang.String name)
(non-Javadoc). |
void |
setWriteDivOnly(boolean writeDivOnly)
Change the _writeDivOnly parameter. |
void |
startComponent(LyWebObject webObject)
Start writing of given component. |
void |
writeBeginPage(java.io.Writer pw,
java.lang.String frame)
Writes the beginning of a HTML page (head, scripts and open the body). |
void |
writeBeginScripts(java.io.Writer pw,
java.lang.String frame)
Writes the begin scripts of the given frame. |
void |
writeCssScripts(java.io.Writer pw,
java.lang.String frame)
Writes CSS scritps associated to the given frame into the given writer. |
boolean |
writeDivOnly()
(non-Javadoc). |
void |
writeEndPage(java.io.Writer pw,
java.lang.String frame)
Writes the end of HTML page. |
void |
writeEndScripts(java.io.Writer pw,
java.lang.String frame)
Writes the end scripts of the given frame. |
void |
writeHtml(java.io.Writer pw,
java.lang.String frame)
(non-Javadoc). |
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.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.web.LyWebComponent |
---|
writeHtml |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final java.lang.String MAIN_BUFFER
public static boolean FORCE_AJAX
Constructor Detail |
---|
public LyWebPageWriter(LyComponent component)
component
- the component of this pageMethod Detail |
---|
public void init()
public void free()
free
in interface LyGraphicalComponent
free
in interface LyFreeInterface
free
in class LyWebObject
LyFreeInterface.free()
public java.lang.String getId()
getId()
public void writeHtml(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
java.io.IOException
writeHtml(java.io.Writer, java.lang.String)
public void preparePage(java.lang.String frame, java.lang.String targetWindow)
preparePage(java.lang.String, java.lang.String)
public void writeBeginPage(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the frame where the page is written
java.io.IOException
- if something is wrong during page writingpublic void setBodyClassName(java.lang.String bodyClassName)
bodyClassName
- the CSS class name to be used.public void writeBeginScripts(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the wrame
java.io.IOException
getBeginScriptsAsHtml(String)
public void writePageContent(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the frame to write
java.io.IOException
public java.lang.String getOpenFormContent(java.lang.String frame)
frame
- the frame to writepublic java.lang.String getOpenFormContent(java.lang.String frame, boolean force)
frame
- the frame to writeforce
- indicates whether form must be generated event if no form
name has been specified on this page writerpublic void writeCssScripts(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the frame to write CSS scripts
java.io.IOException
getCssScriptsAsHtml(String, boolean)
public void writeEndScripts(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the wrame
java.io.IOException
getEndScriptsAsHtml(String)
public void writeEndPage(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
pw
- the page writerframe
- the frame where the page is written
java.io.IOException
- if something is wrong during end page writespublic java.lang.StringBuffer getBuffer(java.lang.String frame)
frame
- the frame
public java.lang.String getFormId(java.lang.String frame)
frame
- the frame
setFormId(String)
public java.lang.String getAttachmentHandler(java.lang.String key)
getAttachmentHandler(java.lang.String)
public java.lang.String getAttachmentDirectory(java.lang.String key)
getAttachmentDirectory(java.lang.String)
public void clearBeginScripts()
clearBeginScripts()
public void clearEndScripts()
clearEndScripts()
public void clearCssScripts()
clearCssScripts()
public void clearBeginScripts(java.lang.String name)
name
- the name of the frame begin scripts to clear.public void clearEndScripts(java.lang.String name)
name
- the name of the frame end scripts to clear.public void clearCssScripts(java.lang.String name)
name
- the name of the frame of all CSS scripts to clear.public void clearBuffer(java.lang.String name)
clearBuffer(java.lang.String)
public void setActiveBuffer(java.lang.String name)
setActiveBuffer(java.lang.String)
public final void append(java.lang.String string)
append(java.lang.String)
public java.lang.String getActiveName()
getActiveName()
public void addBeginScript(java.lang.String text, boolean isFile)
addBeginScript(java.lang.String, boolean)
public void addEndScript(java.lang.String text, boolean isFile)
addEndScript(java.lang.String, boolean)
public void addEndScript(java.lang.String text, boolean isFile, boolean insertEnd)
addEndScript(java.lang.String, boolean)
public void addCssScript(java.lang.String text, boolean isFile)
addCssScript(java.lang.String, boolean)
public void copyScriptsTo(LyWebPageWriter pw)
pw
- the page writerpublic void setFormId(java.lang.String formId)
setFormId(java.lang.String)
public void setAttachmentHandler(java.lang.String attachmentHandler)
handler
- is set by a File fieldItem. default handler is
leon.view.web.LyFileAttachmentHandlerLyWebForm#getAttachmentHandler
public void setAttachmentHandler(java.lang.String key, java.lang.String attachmentHandler)
key
- key used to save attachment handlerhandler
- is set by a File fieldItem. default handler is
leon.view.web.LyFileAttachmentHandlerLyWebForm#getAttachmentHandler
public void setAttachmentDirectory(java.lang.String attachmentDirectory)
key
- key used to save attachment directoryhandler
- is set by a File fieldItem. default directory is 'files'LyWebForm#getAttachmentHandler
public void setAttachmentDirectory(java.lang.String key, java.lang.String attachmentDirectory)
handler
- is set by a File fieldItem. default directory is 'files'LyWebForm#getAttachmentHandler
public java.lang.String getActiveFormId()
public java.lang.StringBuffer getBeginScriptsAsHtml(java.lang.String frame)
frame
- the given frame
getBeginScripts(String)
public java.lang.StringBuffer getEndScriptsAsHtml(java.lang.String frame)
frame
- the given frame
getEndScripts(String)
public java.lang.StringBuffer getCssScriptsAsHtml(java.lang.String frame, boolean file)
frame
- the framefile
- indicates if the CSS script is in a file or not
getCssScripts(String)
public java.lang.StringBuffer getCssFileAsHtml(java.lang.String frame)
frame
- the frame
public void setVisible(boolean status)
public void setInnerView(boolean innerView)
setInnerView(boolean)
public boolean isVisible()
public boolean isInnerView()
isInnerView()
public boolean isFrameSet()
isFrameSet()
public abstract java.util.Vector<LyWebPageWriter> getPageWriters()
getPageWriters()
public void setFrameName(java.lang.String name)
setFrameName(java.lang.String)
public void setWindowName(java.lang.String name)
setWindowName(java.lang.String)
public java.lang.String getWindowName()
getWindowName()
public java.lang.String getTarget()
getTarget()
public void setTitle(java.lang.String title)
setTitle(java.lang.String)
public void setBackgroundColor(java.lang.String hexColor, java.lang.String frame)
hexColor
- the string that represents the hexadecimal code for the colorframe
- the frame to associate to this background colorgetBackgroundColor(String)
public java.lang.String getBackgroundColor(java.lang.String frame)
frame
- the frame
setBackgroundColor(String, String)
public void setBackground(java.lang.String image)
image
- the image that must be used as a motifgetBackgroundColor(String)
public java.lang.String getBackground()
setBackground(String)
public java.lang.String getScriptRoot()
public void setNoFrames(boolean noFrames)
noFrames
- if true, means that no frame set is used, false otherwisepublic boolean isNoFrames()
public java.lang.String getFrameName()
getFrameName()
public void setLastModified(LyViewManager viewManager, long lastModified)
setLastModified(leon.view.LyViewManager, long)
public void setForceReloadState(boolean force)
setForceReloadState(boolean)
public boolean getForceReloadState()
getForceReloadState()
public long getLastReloadTime()
getLastReloadTime()
public void setPrintMode(boolean printMode)
setPrintMode(boolean)
public boolean isPrintMode()
isPrintMode()
public java.util.Vector<java.lang.String> getOldIds()
getOldIds()
public long getNextJavaScriptId()
getNextJavaScriptId()
public void setProperty(java.lang.String name, java.lang.String value)
setProperty(java.lang.String, java.lang.String)
public java.lang.String getProperty(java.lang.String name)
getProperty(java.lang.String)
public void setWriteDivOnly(boolean writeDivOnly)
public boolean writeDivOnly()
writeDivOnly()
public java.lang.String getActionUrl()
action
attribute of the
<FORM>
HTML tag.
public abstract java.lang.String getRedirect(java.lang.String frame)
frame
- the frame to redirect
public void startComponent(LyWebObject webObject)
public void endComponent(LyWebObject webObject)
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |