public interface IlvFacesDHTMLViewSupport extends IlvDHTMLHelper
ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Modifier and Type | Method and Description |
---|---|
Color |
getBackgroundColor()
Returns the background color of the view
|
String |
getBeforeSessionExpirationHandler()
Returns the JavaScript code that will be called when the session is about to expire.
|
String |
getErrorMessage()
Returns the message displayed by the view if an error occurred during the image
generation by the server.
|
IlvImageMapAreaGenerator |
getImageMapGenerator()
Returns the image map generator.
|
String |
getImageMapGeneratorClass()
Returns the image map generator class name.
|
String |
getOnCapabilitiesLoaded()
Returns the JavaScript code executed when the capabilities are loaded from
the server.
|
String |
getOnImageLoaded()
Returns the JavaScript code that is executed when the image is loaded.
|
String |
getStateURL()
Returns a string that represents the client view state.
|
IlvTileManager |
getTileManager()
Returns the tile manager.
|
int |
getUpdateInterval()
Returns the interval in seconds between two automatic updates.
|
IlvManagerView |
getView()
Returns the manager view to be displayed by the helped view.
|
boolean |
isAccessible()
Returns whether the view is accessible or not.
|
boolean |
isGenerateImageMap()
Returns the flag indicating that an image map should be generated.
|
boolean |
isImageMapVisible()
Returns the flag indicating whether an image map should be visible or not (if
generated)
|
boolean |
isResizable()
Returns whether the view is resizable or not.
|
void |
setAccessible(boolean accessible)
Sets whether the view is accessible or not.
|
void |
setBackgroundColor(Color backgroundColor)
Sets the background color of the view.
|
void |
setBeforeSessionExpirationHandler(String handler)
Sets the JavaScript code that will be called when the session is about to expire.
|
void |
setErrorMessage(String errorMessage)
The message displayed by the view if an error occurred during the image
generation by the server.
|
void |
setGenerateImageMap(boolean generateImageMap)
Sets the flag indicating whether an image map should be generated or not.
|
void |
setImageMapGenerator(IlvImageMapAreaGenerator imageMapGenerator)
Sets the image map generator.
|
void |
setImageMapGeneratorClass(String imageMapGeneratorClass)
Sets the image map generator class name.
|
void |
setImageMapVisible(boolean imageMapVisible)
Sets the flag indicating whether an image map should be visible or not (if generated)
|
void |
setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
The JavaScript code executed when the capabilities are loaded from the
server.
|
void |
setOnImageLoaded(String onImageLoaded)
The JavaScript code that is executed when the image is loaded.
|
void |
setResizable(boolean resizable)
Sets whether the view is resizable or not.
|
void |
setStateURL(String clientState)
Sets the client state of the component.
|
void |
setTileManager(IlvTileManager tileManager)
Sets the tile manager.
|
void |
setUpdateInterval(int updateInterval)
The interval in seconds between two automatic updates.
|
getImageFormat, getServlet, getServletClass, getServletURL, getWaitingImage, restoreState, saveState, setImageFormat, setServlet, setServletClass, setServletURL, setValue, setWaitingImage, updateModel
int getUpdateInterval()
void setUpdateInterval(int updateInterval)
updateInterval
- The new update interval to set.boolean isGenerateImageMap()
true
if the image map will be generated, false
otherwise.void setGenerateImageMap(boolean generateImageMap)
generateImageMap
- The flag value to set.boolean isImageMapVisible()
true
if the image map will be shown, false
otherwise.void setImageMapVisible(boolean imageMapVisible)
imageMapVisible
- The flag value to set.IlvImageMapAreaGenerator getImageMapGenerator()
Returns the image map generator.
If thegenerateImageMap
property is true
,
this generator will be invoked to dynamically create the image map.
void setImageMapGenerator(IlvImageMapAreaGenerator imageMapGenerator)
Sets the image map generator.
If thegenerateImageMap
property is true
,
this generator will be invoked to dynamically create the image map.
imageMapGenerator
- The image map generator.String getImageMapGeneratorClass()
Returns the image map generator class name.
If the generateImageMap
property is true
, and
the imageMapgenerator
property is not set, an instance of this generator
will be created and this generator will be invoked to dynamically create the image map.
void setImageMapGeneratorClass(String imageMapGeneratorClass)
Sets the image map generator class name.
If the generateImageMap
property is true
, and
the imageMapgenerator
property is not set, an instance of this generator
will be created and this generator will be invoked to dynamically create the image map.
imageMapGeneratorClass
- The image map generator class name.Color getBackgroundColor()
void setBackgroundColor(Color backgroundColor)
backgroundColor
- The background color to set.String getOnImageLoaded()
imageLoaded
event.void setOnImageLoaded(String onImageLoaded)
onImageLoaded
- The new JavaScript function handler.String getOnCapabilitiesLoaded()
capabilitiesLoaded
event.void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
onCapabilitiesLoaded
- The new JavaScript function handler.String getErrorMessage()
void setErrorMessage(String errorMessage)
errorMessage
- The new error message to set.String getStateURL()
void setStateURL(String clientState)
clientState
- The client state of the component.boolean isResizable()
void setResizable(boolean resizable)
resizable
- The resizable flag to set.boolean isAccessible()
void setAccessible(boolean accessible)
accessible
- The accessible flag to set.IlvManagerView getView() throws Exception
Exception
IlvTileManager getTileManager()
The tile manager is used when the view is tiled, that is, if the tileSize
property is greater or equals to 0.
void setTileManager(IlvTileManager tileManager)
The tile manager is used when the view is tiled, that is, if the tileSize
property is greater or equals to 0.
tileManager
- The tile manager to set.void setBeforeSessionExpirationHandler(String handler)
This code can use the view
implicit variable that represents the JavaScript proxy of this component.
handler
- The JavasScript code.String getBeforeSessionExpirationHandler()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.