|
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
leon.view.web.struts.LyStrutsContainer
leon.view.web.struts.LyStrutsArea
public class LyStrutsArea
This class implements the Area object (as described in the dtd) for web viewer.
AREA: Area
An area allows the positioning of various graphical components inside a main window or a dialog
window. It can contains any type of panel as well as a title bar, a tool bar and a command bar.
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static int |
BORDER_PANEL_MIN_HEIGHT
Minimum height of the border panels. |
static java.lang.String |
BOTTOMTOOLBAR
The bottomtoolbar string representation used within frames names. |
static java.lang.String |
CENTER
The center string representation used within frames names. |
static java.lang.String |
COMMANDS
The commands string representation used within frames names. |
static int |
DECO_AREA_PARAMETER
Constant used to generate CSS class name for area. |
static int |
DECO_TIP_PARAMETER
Constant used to generate CSS class name for tip. |
static java.lang.String |
EASTPANEL
The eastpanel string representation used to build frame with eastpanel names. |
static java.lang.String |
ELEMENT
The element string representation used within frames names. |
static int |
FRAME_MAX_HEIGHT
Indicates the max heightof a frame in dhtml. |
static int |
FRAME_MAX_WIDTH
Indicates the max width of a frame in dhtml. |
static int |
IMAGE_TOOLBAR_SIZE
The toolbar image size. |
static int |
LABEL_TOOLBAR_SIZE
The toolbar label size. |
static java.lang.String |
LEFT
The left string representation used within frames names. |
static java.lang.String |
NORTHPANEL
The northpanel string representation used to build frame with northpanel names. |
static java.lang.String |
RIGHT
The right string representation used within frames names. |
static int |
SCROLLBAR_SIZE
The scrollbar size. |
static java.lang.String |
SELECTBAR
The selectbar string representation used within frames names. |
static java.lang.String |
SOUTHPANEL
The southpanel string representation used to build frame with southpanel names. |
static int |
TITLEBAR_SIZE
The titlebar size. |
static int |
TOOLBAR_SIZE
The toolbar size. |
static java.lang.String |
TOOLTITLE
The tooltitle string representation used to build frame with tooltitle names. |
static boolean |
USE_AJAX_FOR_BORDER_PANELS
Indicates whether Ajax must be used to refresh border panels. |
static java.lang.String |
WESTPANEL
The westpanel string representation used to build frame with westpanel 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 | |
---|---|
LyStrutsArea(LyArea area)
Constructor. |
Method Summary | |
---|---|
void |
addPanel(LyPanel panel,
int pos)
(non-Javadoc). |
void |
clearBeginScripts()
(non-Javadoc). |
void |
clearCssScripts()
(non-Javadoc). |
void |
clearEndScripts()
(non-Javadoc). |
boolean |
containsLabel(LyToolBar toolBar)
Parses the tools contained in this toolBar and search if at least one has a label. |
void |
free()
(non-Javadoc). |
java.lang.String |
getActionUrl()
Method overriden to return the URL to the "Command" struts action path. |
int |
getAreaHeight()
Returns the height of area if fixed. |
int |
getAreaWidth()
Returns the width of area if fixed. |
java.lang.StringBuffer |
getBuffer(java.lang.String key)
(non-Javadoc). |
java.lang.String |
getMainFrameName()
Gets name of the main frame. |
LyMenuBar |
getMenuBar()
Gets the area's parent's menu bar. |
java.util.Vector<LyWebPageWriter> |
getPageWriters()
(non-Javadoc). |
java.lang.String |
getRedirect(java.lang.String frame)
(non-Javadoc). |
java.lang.String |
getRootUrl()
Method overriden to redirect the root URL to the page action handler. |
java.lang.String |
getToolbarClass()
Gets the css class of the toolbars for this area. |
boolean |
hasMenuBar()
Check if this area has a menu bar. |
void |
init()
(non-Javadoc). |
boolean |
isFrameSet()
(non-Javadoc). |
boolean |
isSubFrameSet(java.lang.String frame)
Indicates if the specified frame is also a sub frame set. |
void |
preparePage(java.lang.String frame,
java.lang.String targetWindow)
(non-Javadoc). |
void |
refresh()
(non-Javadoc). |
void |
removePanel(LyPanel panel)
(non-Javadoc). |
void |
setBorderPanel(LyPanel panel,
short position)
Set a border panel at the given position. |
void |
setForceReloadState(boolean force)
(non-Javadoc). |
void |
setLayoutInfo(java.lang.String layoutInfo)
Updates attribute layoutInfo to the given value. |
void |
setNoFrames(boolean noFrames)
(non-Javadoc). |
void |
setOpen(boolean open)
Updates attribute open to the given value. |
void |
setPrintMode(boolean printMode)
(non-Javadoc). |
void |
setRedirect(java.lang.String redirect)
(non-Javadoc) |
void |
setRefresh(int duration)
(non-Javadoc). |
void |
setVisible(boolean status)
(non-Javadoc). |
void |
writeBeginPage(java.io.Writer pw,
java.lang.String frame)
(non-Javadoc). |
void |
writeEndPage(java.io.Writer pw,
java.lang.String frame)
(non-Javadoc). |
static void |
writeFrame(java.lang.String id,
java.lang.String windowName,
LyWebPageWriter pw,
java.lang.String rootURL,
java.lang.String frameName,
java.lang.String forceReload,
boolean scrolling,
boolean autoWidth,
boolean autoHeight,
java.lang.String maxHeight,
java.lang.String maxWidth)
Write an iframe to fetch a subelement. |
void |
writeGlobalFrameSet(LyWebPageWriter pw)
Write the FRAMESET structure of the page. |
void |
writeGlobalFrameSet(LyWebPageWriter pw,
boolean autoWidth,
boolean autoHeight)
Write the FRAMESET structure of the page. |
void |
writeHtml(LyWebPageWriter pw)
Write HTML description corresponding to this component. |
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, getScrollHeightForSplitter, getUrl, getWebViewManager, 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.LyGraphicalComponent |
---|
getViewComponent |
Field Detail |
---|
public static final java.lang.String __VERSION
public static int FRAME_MAX_HEIGHT
public static int FRAME_MAX_WIDTH
public static int DECO_AREA_PARAMETER
public static int DECO_TIP_PARAMETER
public static final int TOOLBAR_SIZE
public static final int IMAGE_TOOLBAR_SIZE
public static final int LABEL_TOOLBAR_SIZE
public static final int SCROLLBAR_SIZE
public static final int TITLEBAR_SIZE
public static final int BORDER_PANEL_MIN_HEIGHT
public static final java.lang.String TOOLTITLE
public static final java.lang.String NORTHPANEL
public static final java.lang.String SOUTHPANEL
public static final java.lang.String WESTPANEL
public static final java.lang.String EASTPANEL
public static final java.lang.String SELECTBAR
public static final java.lang.String COMMANDS
public static final java.lang.String ELEMENT
public static final java.lang.String LEFT
public static final java.lang.String CENTER
public static final java.lang.String RIGHT
public static final java.lang.String BOTTOMTOOLBAR
public static boolean USE_AJAX_FOR_BORDER_PANELS
Constructor Detail |
---|
public LyStrutsArea(LyArea area)
area
- the area componentMethod Detail |
---|
public void writeHtml(LyWebPageWriter pw)
LyWebComponent
writeHtml
in interface LyWebComponent
pw
- the page writerpublic void setBorderPanel(LyPanel panel, short position)
setBorderPanel
in interface LySetBorderPanelInterface
panel
- the border panel.position
- Either NORTH, SOUTH, EAST or WEST position.public void addPanel(LyPanel panel, int pos)
addPanel
in interface LyGraphicalArea
panel
- The panels to add to panels list.pos
- Position where the sub-component is inserted.LyGraphicalArea.addPanel(leon.view.LyPanel, int)
public void removePanel(LyPanel panel)
removePanel
in interface LyGraphicalArea
panel
- The panels to remove to panels list.LyGraphicalArea.removePanel(leon.view.LyPanel)
public void setOpen(boolean open)
LyGraphicalArea
setOpen
in interface LyGraphicalArea
open
- Boolean indicating if attribute open is set or unset.public java.lang.String getRootUrl()
getRootUrl
in class LyWebObject
LyWebObject.getRootURL(LyEnvironment)
public java.lang.String getActionUrl()
getActionUrl
in class LyWebPageWriter
public int getAreaWidth()
public int getAreaHeight()
public void init()
init
in class LyWebPageWriter
leon.view.web.LyWebPage#init()
public java.lang.String getToolbarClass()
public java.lang.String getMainFrameName()
public void writeBeginPage(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
writeBeginPage
in class LyWebPageWriter
pw
- the page writerframe
- the frame where the page is written
java.io.IOException
- if something is wrong during page writingleon.view.web.LyWebPage#writeBeginPage(java.io.Writer, java.lang.String)
public void writeEndPage(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
writeEndPage
in class LyWebPageWriter
pw
- the page writerframe
- the frame where the page is written
java.io.IOException
- if something is wrong during end page writesleon.view.web.LyWebPage#writeEndPage(java.io.Writer, java.lang.String)
public java.lang.String getRedirect(java.lang.String frame)
getRedirect
in class LyWebPageWriter
frame
- the frame to redirect
LyWebPageWriter.getRedirect(java.lang.String)
public void setVisible(boolean status)
setVisible
in interface LySetVisibleInterface
setVisible
in class LyWebPageWriter
status
- new visibility status, if true the component will be shown, if false it will be
hidenleon.view.web.LyWebPage#setVisible(boolean)
public void setNoFrames(boolean noFrames)
setNoFrames
in class LyWebPageWriter
noFrames
- if true, means that no frame set is used, false otherwiseleon.view.web.LyWebPage#setNoFrames(boolean)
public void setPrintMode(boolean printMode)
setPrintMode
in class LyWebPageWriter
LyWebPageWriter.setPrintMode(boolean)
public java.util.Vector<LyWebPageWriter> getPageWriters()
getPageWriters
in class LyWebPageWriter
LyWebPageWriter.getPageWriters()
public void setForceReloadState(boolean force)
setForceReloadState
in class LyWebPageWriter
LyWebPageWriter.setForceReloadState(boolean)
public java.lang.StringBuffer getBuffer(java.lang.String key)
getBuffer
in class LyWebPageWriter
key
- the frame
leon.view.web.LyWebPage#getBuffer(java.lang.String)
public void setRefresh(int duration)
setRefresh
in interface LyGraphicalArea
duration
- New value of refresh.LyGraphicalArea.setRefresh(int)
public void free()
free
in interface LyGraphicalComponent
free
in interface LyFreeInterface
free
in class LyWebPageWriter
LyFreeInterface.free()
public void refresh()
refresh
in class LyWebObject
LyWebObject.refresh()
public boolean containsLabel(LyToolBar toolBar)
toolBar
- the toolbar to parse
public void clearBeginScripts()
clearBeginScripts
in class LyWebPageWriter
LyWebPageWriter.clearBeginScripts()
public void clearEndScripts()
clearEndScripts
in class LyWebPageWriter
LyWebPageWriter.clearEndScripts()
public void clearCssScripts()
clearCssScripts
in class LyWebPageWriter
LyWebPageWriter.clearCssScripts()
public boolean isSubFrameSet(java.lang.String frame)
frame
- the frame
public void preparePage(java.lang.String frame, java.lang.String targetWindow)
preparePage
in class LyWebPageWriter
LyWebPageWriter.preparePage(java.lang.String, java.lang.String)
public LyMenuBar getMenuBar()
public boolean hasMenuBar()
public boolean isFrameSet()
isFrameSet
in class LyWebPageWriter
LyWebPageWriter.isFrameSet()
public static void writeFrame(java.lang.String id, java.lang.String windowName, LyWebPageWriter pw, java.lang.String rootURL, java.lang.String frameName, java.lang.String forceReload, boolean scrolling, boolean autoWidth, boolean autoHeight, java.lang.String maxHeight, java.lang.String maxWidth)
id
- the frame idwindowName
- the window namepw
- the page writerrootURL
- the root URLframeName
- the frame nameforceReload
- the value to print in URL to indicates that the relaod is forcedscrolling
- indicates if the frame is scrolled. If true, set the HTML frame attribute
'scrolling' to 'auto', if false, set it to 'no' .autoWidth
- auto resize the iframe in javascript (width parameter)autoHeight
- auto resize the iframe in javascript (height parameter)maxHeight
- the maximum heightmaxWidth
- the maximum widthpublic void writeGlobalFrameSet(LyWebPageWriter pw)
pw
- the page writerpublic void writeGlobalFrameSet(LyWebPageWriter pw, boolean autoWidth, boolean autoHeight)
pw
- the page writerautoWidth
- auto resize the iframe in javascript (width parameter)autoHeight
- auto resize the iframe in javascript (height parameter)public void setRedirect(java.lang.String redirect)
setRedirect
in interface LyGraphicalArea
redirect
- New value of redirect.LyGraphicalArea.setRedirect(java.lang.String)
public void setLayoutInfo(java.lang.String layoutInfo)
LyGraphicalArea
setLayoutInfo
in interface LyGraphicalArea
layoutInfo
- New value of layoutInfo.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |