|
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.LyStrutsMap
public class LyStrutsMap
This class implements the Map object (as described in the dtd) for Struts viewer.
LyMap
Nested Class Summary | |
---|---|
static class |
LyStrutsMap.TranslationDirection
Directions that may be used to translate the map component. |
static class |
LyStrutsMap.ViewerPosition
Possible positions of the viewer widget. |
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static boolean |
CLEAR_MAP_FILES
Force the map to keep the ten last map files and to destroy the oldest. |
static int |
MAP_HEIGHT
the map height. |
static int |
MAP_WIDTH
The map width. |
static int |
MAX_TEMP_FILES
Deprecated. |
static boolean |
NO_BACKGROUND
|
static java.awt.Color |
VIEWER_BORDER_COLOR
Color used for the border of the viewer. |
static java.awt.Color |
VIEWER_DISPLAYED_PART_BORDER_COLOR
Color used for the border of the displayed part in the viewer. |
static int |
ZOOM_STEPS_NB
Number of steps available in the zoom widget (positive as well as negative). |
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 | |
---|---|
LyStrutsMap(LyMap map)
Class constructor of a Map object for the struts target. |
Method Summary | |
---|---|
void |
addComponent(LyComponent component,
int pos)
(non-Javadoc). |
void |
free()
(non-Javadoc). |
java.lang.String |
generateMapImage(int xoffset,
int yoffset,
int width,
int height,
boolean viewer)
|
java.awt.Color |
getColor(java.lang.String key)
Retrieves a Color from the current environment. |
java.awt.Component |
getComponent()
Gets the map box component. |
static java.awt.Frame |
getDefaultFrame()
Gets the default frame. |
java.awt.Font |
getFont(java.lang.String key)
Retrieves a Font from the current environment. |
static java.lang.String |
getHexString(java.awt.Color color)
Gets the hexadecimal string representing the given color. |
java.awt.Image |
getImage(java.lang.String key)
Retrieves an image from the current environment. |
leon.view.web.struts.map.LyStrutsMapCanvas |
getMapCanvas()
Returns the map canvas. |
java.awt.Dimension |
getMapDimension()
Returns the dimension of the generated image. |
LyStrutsMapNode |
getNodeById(java.lang.String nodeId)
Gets the node cprresponding to the given Id. |
java.util.Vector<LyWebPageWriter> |
getPageWriters()
(non-Javadoc). |
java.lang.String |
getRedirect(java.lang.String frame)
(non-Javadoc). |
int |
getScrollHeightForSplitter(LyWebPageWriter pw)
Indicates whether this component needs scrollbars when inserted in a splitter. |
void |
init()
(non-Javadoc). |
boolean |
isFrameSet()
(non-Javadoc). |
boolean |
isIdle()
Checks if the component is idle or not. |
void |
preparePage(java.lang.String frame,
java.lang.String targetWindow)
(non-Javadoc). |
void |
refreshMapImage()
Set the _refreshBackgroundImage attribute in order to refresh the background image used by the map. |
void |
refreshViewerImage()
Set the _refreshViewerImage attribute in order to refresh the viewer image used by the map. |
void |
removeComponent(LyComponent component)
(non-Javadoc). |
void |
resetContent()
(non-Javadoc). |
void |
resetContent(boolean full)
(non-Javadoc). |
void |
resetElementsPositions()
Resets the position of all the elements contained in the map. |
void |
setContent()
Sets the content of the map. |
void |
setIdle(boolean status)
(non-Javadoc). |
void |
setLabel(java.lang.String label)
(non-Javadoc). |
void |
setLayout(LyLayout layout)
(non-Javadoc). |
void |
setMapContent(LyMapContent mapContent)
Sets sub-component mapContent. |
void |
setPopupMenu(LyPopupMenu popup)
Sets the popup menu with the given value. |
void |
setSpatial(boolean spatial)
(non-Javadoc). |
void |
setTranslation(boolean translation)
Updates attribute translation to the given value. |
void |
setTranslationStatus(LyMapBase.TranslationStatus translationStatus)
(non-Javadoc). |
void |
setViewer(boolean viewer)
(non-Javadoc). |
void |
setViewerStatus(LyMapBase.ViewerStatus viewerStatus)
(non-Javadoc). |
void |
setVisible(boolean status)
(non-Javadoc). |
void |
setZoom(boolean zoom)
Updates attribute zoom to the given value. |
void |
setZoomFactor(float zoomFactor)
Updates attribute zoomFactor to the given value. |
void |
setZoomStatus(LyMapBase.ZoomStatus zoomStatus)
(non-Javadoc). |
void |
updateBackgroundImage()
Refresh the background image used by the map. |
void |
updateViewerImage()
Refresh the viewer image used by the map. |
void |
writeBeginPage(java.io.Writer pw,
java.lang.String frame)
(non-Javadoc). |
void |
writeHiddenFrame(LyWebPageWriter pw)
Writes HTML description corresponding to this component. |
void |
writeHtml(LyWebPageWriter pw)
(non-Javadoc). |
void |
writeHtml(java.io.Writer pw,
java.lang.String frame)
(non-Javadoc). |
void |
writeMapFrame(LyWebPageWriter pw)
Write HTML description of the map frame. |
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, 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.LyGraphicalComponent |
---|
getViewComponent |
Field Detail |
---|
public static final java.lang.String __VERSION
public static java.awt.Color VIEWER_BORDER_COLOR
public static java.awt.Color VIEWER_DISPLAYED_PART_BORDER_COLOR
public static int ZOOM_STEPS_NB
public static int MAP_WIDTH
public static int MAP_HEIGHT
public static int MAX_TEMP_FILES
public static boolean NO_BACKGROUND
public static boolean CLEAR_MAP_FILES
Constructor Detail |
---|
public LyStrutsMap(LyMap map)
map
- the generic Map defined for every type of view targets.Method Detail |
---|
public static java.awt.Frame getDefaultFrame()
public static java.lang.String getHexString(java.awt.Color color)
color
- the color to convert.
public void writeHtml(LyWebPageWriter pw)
writeHtml
in interface LyWebComponent
pw
- the page writerLyWebComponent.writeHtml(leon.view.web.LyWebPageWriter)
public void writeHtml(java.io.Writer pw, java.lang.String frame) throws java.io.IOException
writeHtml
in class LyWebPageWriter
java.io.IOException
LyWebPageWriter.writeHtml(java.io.Writer, java.lang.String)
public void writeMapFrame(LyWebPageWriter pw)
pw
- the page writerpublic java.lang.String generateMapImage(int xoffset, int yoffset, int width, int height, boolean viewer)
public void free()
free
in interface LyGraphicalComponent
free
in interface LyFreeInterface
free
in class LyWebPageWriter
LyFreeInterface.free()
public void refreshViewerImage()
_refreshViewerImage
attribute in order to refresh the viewer image used by the map.
public void setIdle(boolean status)
setIdle
in interface LySetIdleInterface
status
- new idle status (LySetIdleInterface interface)LySetIdleInterface.setIdle(boolean)
public void updateBackgroundImage()
public void updateViewerImage()
public void removeComponent(LyComponent component)
removeComponent
in interface LyGraphicalMap
component
- The components to remove to components list.LyGraphicalMap.removeComponent(leon.view.LyComponent)
public int getScrollHeightForSplitter(LyWebPageWriter pw)
LyWebObject
getScrollHeightForSplitter
in class LyWebObject
pw
- current page writer
public leon.view.web.struts.map.LyStrutsMapCanvas getMapCanvas()
public void resetElementsPositions()
public boolean isIdle()
public void setZoomFactor(float zoomFactor)
LyGraphicalMap
setZoomFactor
in interface LyGraphicalMap
zoomFactor
- New value of zoomFactor.public void setTranslationStatus(LyMapBase.TranslationStatus translationStatus)
setTranslationStatus
in interface LyGraphicalMap
translationStatus
- New value of translationStatus.LyGraphicalMap.setTranslationStatus(leon.view.LyMapBase.TranslationStatus)
public void setZoomStatus(LyMapBase.ZoomStatus zoomStatus)
setZoomStatus
in interface LyGraphicalMap
zoomStatus
- New value of zoomStatus.LyGraphicalMap.setZoomStatus(leon.view.LyMapBase.ZoomStatus)
public void setViewerStatus(LyMapBase.ViewerStatus viewerStatus)
setViewerStatus
in interface LyGraphicalMap
viewerStatus
- New value of viewerStatus.LyGraphicalMap.setViewerStatus(leon.view.LyMapBase.ViewerStatus)
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 preparePage(java.lang.String frame, java.lang.String targetWindow)
preparePage
in class LyWebPageWriter
LyWebPageWriter.preparePage(java.lang.String, java.lang.String)
public void init()
init
in class LyWebPageWriter
leon.view.web.LyWebPage#init()
public void setPopupMenu(LyPopupMenu popup)
setPopupMenu
in interface LySetPopupMenuInterface
popup
- the new popup menupublic void setContent()
public void addComponent(LyComponent component, int pos)
addComponent
in interface LyGraphicalMap
component
- The components to add to components list.pos
- Position where the sub-component is inserted.LyGraphicalMap.addComponent(leon.view.LyComponent, int)
public void writeHiddenFrame(LyWebPageWriter pw)
pw
- the page writerpublic 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 setMapContent(LyMapContent mapContent)
setMapContent
in interface LyGraphicalMap
mapContent
- New value of mapContentpublic void resetContent()
resetContent
in interface LyResetContentInterface
LyResetContentInterface.resetContent()
public void resetContent(boolean full)
resetContent
in interface LyResetContentInterface
full
- indicates whether old components must be removed from graphical view.LyResetContentInterface.resetContent(boolean)
public java.awt.Dimension getMapDimension()
public java.awt.Component getComponent()
public LyStrutsMapNode getNodeById(java.lang.String nodeId)
nodeId
- the id of the wanted node
public void setLabel(java.lang.String label)
setLabel
in interface LyGraphicalMap
setLabel
in interface LySetLabelInterface
label
- New value of label.LySetLabelInterface.setLabel(java.lang.String)
public void setSpatial(boolean spatial)
setSpatial
in interface LyGraphicalMap
spatial
- Boolean indicating if attribute spatial is set or unset.LyGraphicalMap.setSpatial(boolean)
public void setViewer(boolean viewer)
setViewer
in interface LyGraphicalMap
setViewer
in interface LySetViewerInterface
viewer
- Boolean indicating if attribute viewer is set or unset.LySetViewerInterface.setViewer(boolean)
public void setLayout(LyLayout layout)
setLayout
in interface LyGraphicalMap
layout
- New value of layoutLyGraphicalMap.setLayout(leon.view.LyLayout)
public void refreshMapImage()
_refreshBackgroundImage
attribute in order to refresh the background image used by the map.
public java.util.Vector<LyWebPageWriter> getPageWriters()
getPageWriters
in class LyWebPageWriter
LyWebPageWriter.getPageWriters()
public java.lang.String getRedirect(java.lang.String frame)
getRedirect
in class LyWebPageWriter
frame
- the frame to redirect
LyWebPageWriter.getRedirect(java.lang.String)
public final java.awt.Color getColor(java.lang.String key)
key
- The ressource name (key) of the Color.
LyEnvironment.getColor(String)
public final java.awt.Font getFont(java.lang.String key)
key
- The ressource name (key) of the font.
LyEnvironment.getFont(String)
public final java.awt.Image getImage(java.lang.String key)
key
- The ressource name (key) of the image.
LyEnvironment.getImage(String)
public boolean isFrameSet()
isFrameSet
in class LyWebPageWriter
LyWebPageWriter.isFrameSet()
public void setTranslation(boolean translation)
LyGraphicalMap
setTranslation
in interface LyGraphicalMap
translation
- Boolean indicating if attribute translation is set or unset.public void setZoom(boolean zoom)
LyGraphicalMap
setZoom
in interface LyGraphicalMap
zoom
- Boolean indicating if attribute zoom is set or unset.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |