oracle.adfdt.view.dvt.binding.pattern.map

Class PredefinedTheme

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.map.PredefinedTheme

All Implemented Interfaces:

ExtendedProperties

public class PredefinedTheme
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a predefinedTheme.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
PredefinedTheme()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClickAction() Description: Refers to a backing bean method that performs navigation processing for the map and returns an outcome String.
java.lang.String	getClickListener() Description: a method reference to a click listener Refers to a backing bean method that takes MapClickActionEvent as an argument.
java.lang.String	getId() Description: The identifier for the component
java.lang.String	getLeftClickBehavior() Description: Specifies the behavior when user left clicks on an element of a theme.
int	getMaxZoom() Description: Specifies the maximum zoom scale where this theme will still be visible.
java.lang.String	getMaxZoomAsString() Description: Specifies the maximum zoom scale where this theme will still be visible.
java.lang.String	getMenuLabel() Description: Specifies the label of this theme on the ThemeSelectionDialog and SelectMenuItem.
int	getMinZoom() Description: Specifies the minimum zoom scale where this theme will still be visible.
java.lang.String	getMinZoomAsString() Description: Specifies the minimum zoom scale where this theme will still be visible.
java.lang.String	getRightClickBehavior() Description: Specifies the behavior when user right clicks on an element of a theme.
java.lang.String	getSelectionListener() Description: a method reference to a selection listener Refers to a backing bean method that takes MapSelectionEvent as an argument.
java.lang.String	getShortLabel() Description: Specifies the label of this theme on the legend.
java.lang.String	getTagName()
java.lang.String	getThemeName() Description: Specifies the predefined theme on which this theme layer is based.
int	getWindowHeight() Description: Specifies the height of the window if useWindow is true
java.lang.String	getWindowHeightAsString() Description: Specifies the height of the window if useWindow is true This method is provided as a convenience to be able to retrieve an EL that was set on the windowHeight attribute.
int	getWindowWidth() Description: Specifies the width of the window if useWindow is true
java.lang.String	getWindowWidthAsString() Description: Specifies the width of the window if useWindow is true This method is provided as a convenience to be able to retrieve an EL that was set on the windowWidth attribute.
boolean	isRendered() Description: Specifies whether the theme is rendered or not
java.lang.String	isRenderedAsString() Description: Specifies whether the theme is rendered or not This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.
boolean	isUseWindow() Description: Specifies whether processes launched by this command should be launched in a secondary dialog window.
java.lang.String	isUseWindowAsString() Description: Specifies whether processes launched by this command should be launched in a secondary dialog window.
void	setClickAction(java.lang.String clickAction) Description: Refers to a backing bean method that performs navigation processing for the map and returns an outcome String.
void	setClickListener(java.lang.String clickListener) Description: a method reference to a click listener Refers to a backing bean method that takes MapClickActionEvent as an argument.
void	setId(java.lang.String id) Description: The identifier for the component
void	setLeftClickBehavior(java.lang.String leftClickBehavior) Description: Specifies the behavior when user left clicks on an element of a theme.
void	setMaxZoom(int maxZoom) Description: Specifies the maximum zoom scale where this theme will still be visible.
void	setMaxZoomAsString(java.lang.String maxZoom) Description: Specifies the maximum zoom scale where this theme will still be visible.
void	setMenuLabel(java.lang.String menuLabel) Description: Specifies the label of this theme on the ThemeSelectionDialog and SelectMenuItem.
void	setMinZoom(int minZoom) Description: Specifies the minimum zoom scale where this theme will still be visible.
void	setMinZoomAsString(java.lang.String minZoom) Description: Specifies the minimum zoom scale where this theme will still be visible.
void	setRendered(boolean rendered) Description: Specifies whether the theme is rendered or not
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the theme is rendered or not This method is provided as a convenience to be able to set an EL on the rendered attribute.
void	setRightClickBehavior(java.lang.String rightClickBehavior) Description: Specifies the behavior when user right clicks on an element of a theme.
void	setSelectionListener(java.lang.String selectionListener) Description: a method reference to a selection listener Refers to a backing bean method that takes MapSelectionEvent as an argument.
void	setShortLabel(java.lang.String shortLabel) Description: Specifies the label of this theme on the legend.
void	setThemeName(java.lang.String themeName) Description: Specifies the predefined theme on which this theme layer is based.
void	setUseWindow(boolean useWindow) Description: Specifies whether processes launched by this command should be launched in a secondary dialog window.
void	setUseWindowAsString(java.lang.String useWindow) Description: Specifies whether processes launched by this command should be launched in a secondary dialog window.
void	setWindowHeight(int windowHeight) Description: Specifies the height of the window if useWindow is true
void	setWindowHeightAsString(java.lang.String windowHeight) Description: Specifies the height of the window if useWindow is true This method is provided as a convenience to be able to set an EL on the windowHeight attribute.
void	setWindowWidth(int windowWidth) Description: Specifies the width of the window if useWindow is true
void	setWindowWidthAsString(java.lang.String windowWidth) Description: Specifies the width of the window if useWindow is true This method is provided as a convenience to be able to set an EL on the windowWidth attribute.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PredefinedTheme

public PredefinedTheme()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getClickAction

public java.lang.String getClickAction()

Description: Refers to a backing bean method that performs navigation processing for the map and returns an outcome String. Or a static outcome String can be specified. The JSF NavigationHandler selects the page to display next by matching the outcome String against the navigation rules in the application configuration resource file. The application writes the Navigation rules.

Returns:

the value of the clickAction attribute of the Tag this class represents.

setClickAction

public void setClickAction(java.lang.String clickAction)

Description: Refers to a backing bean method that performs navigation processing for the map and returns an outcome String. Or a static outcome String can be specified. The JSF NavigationHandler selects the page to display next by matching the outcome String against the navigation rules in the application configuration resource file. The application writes the Navigation rules.

Parameters:

clickAction - the value of the clickAction attribute of the Tag this class represents.

getClickListener

public java.lang.String getClickListener()

Description: a method reference to a click listener Refers to a backing bean method that takes MapClickActionEvent as an argument. The MapClickActionEvent contains the information on the clicked point. Sample code: public void processMouseClick(MapClickActionEvent mapClickActionEvent) { if (mapClickActionEvent.getDataContent() != null) { DataContent dt = mapClickActionEvent.getDataContent(); System.out.println ("Location Name: " + dt.getLocationName()); } System.out.println("MouseX " + mapClickActionEvent.getMouseX()); System.out.println("MouseY " + mapClickActionEvent.getMouseY()); } Refers to a backing bean method that takes ClickEvent as argument.

Returns:

the value of the clickListener attribute of the Tag this class represents.

setClickListener

public void setClickListener(java.lang.String clickListener)

Description: a method reference to a click listener Refers to a backing bean method that takes MapClickActionEvent as an argument. The MapClickActionEvent contains the information on the clicked point. Sample code: public void processMouseClick(MapClickActionEvent mapClickActionEvent) { if (mapClickActionEvent.getDataContent() != null) { DataContent dt = mapClickActionEvent.getDataContent(); System.out.println ("Location Name: " + dt.getLocationName()); } System.out.println("MouseX " + mapClickActionEvent.getMouseX()); System.out.println("MouseY " + mapClickActionEvent.getMouseY()); } Refers to a backing bean method that takes ClickEvent as argument.

Parameters:

clickListener - the value of the clickListener attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: The identifier for the component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: The identifier for the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getLeftClickBehavior

public java.lang.String getLeftClickBehavior()

Description: Specifies the behavior when user left clicks on an element of a theme. Valid value of theme are: "Action" - An action event will be fired. "Popup" - A popup will be shown. The content of the popup is defined in the popup facet of the map "InfoWindow" - An InfoWindow will be shown. The user can further customize the content of the infoWindow through the infoWindowCallback "None" - Nothing will be done.

Returns:

the value of the leftClickBehavior attribute of the Tag this class represents.

setLeftClickBehavior

public void setLeftClickBehavior(java.lang.String leftClickBehavior)

Description: Specifies the behavior when user left clicks on an element of a theme. Valid value of theme are: "Action" - An action event will be fired. "Popup" - A popup will be shown. The content of the popup is defined in the popup facet of the map "InfoWindow" - An InfoWindow will be shown. The user can further customize the content of the infoWindow through the infoWindowCallback "None" - Nothing will be done.

Parameters:

leftClickBehavior - the value of the leftClickBehavior attribute of the Tag this class represents.

getMaxZoom

public int getMaxZoom()
               throws java.lang.NumberFormatException

Description: Specifies the maximum zoom scale where this theme will still be visible.

Returns:

the value of the maxZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMaxZoom

public void setMaxZoom(int maxZoom)

Description: Specifies the maximum zoom scale where this theme will still be visible.

Parameters:

maxZoom - the value of the maxZoom attribute of the Tag this class represents.

getMaxZoomAsString

public java.lang.String getMaxZoomAsString()
                                    throws java.lang.NumberFormatException

Description: Specifies the maximum zoom scale where this theme will still be visible. This method is provided as a convenience to be able to retrieve an EL that was set on the maxZoom attribute.

Returns:

the value of the maxZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMaxZoomAsString

public void setMaxZoomAsString(java.lang.String maxZoom)

Description: Specifies the maximum zoom scale where this theme will still be visible. This method is provided as a convenience to be able to set an EL on the maxZoom attribute.

Parameters:

maxZoom - the value of the maxZoom attribute of the Tag this class represents.

getMenuLabel

public java.lang.String getMenuLabel()

Description: Specifies the label of this theme on the ThemeSelectionDialog and SelectMenuItem. If the attribute is not specified, the id of the theme will be used.

Returns:

the value of the menuLabel attribute of the Tag this class represents.

setMenuLabel

public void setMenuLabel(java.lang.String menuLabel)

Description: Specifies the label of this theme on the ThemeSelectionDialog and SelectMenuItem. If the attribute is not specified, the id of the theme will be used.

Parameters:

menuLabel - the value of the menuLabel attribute of the Tag this class represents.

getMinZoom

public int getMinZoom()
               throws java.lang.NumberFormatException

Description: Specifies the minimum zoom scale where this theme will still be visible.

Returns:

the value of the minZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMinZoom

public void setMinZoom(int minZoom)

Description: Specifies the minimum zoom scale where this theme will still be visible.

Parameters:

minZoom - the value of the minZoom attribute of the Tag this class represents.

getMinZoomAsString

public java.lang.String getMinZoomAsString()
                                    throws java.lang.NumberFormatException

Description: Specifies the minimum zoom scale where this theme will still be visible. This method is provided as a convenience to be able to retrieve an EL that was set on the minZoom attribute.

Returns:

the value of the minZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMinZoomAsString

public void setMinZoomAsString(java.lang.String minZoom)

Description: Specifies the minimum zoom scale where this theme will still be visible. This method is provided as a convenience to be able to set an EL on the minZoom attribute.

Parameters:

minZoom - the value of the minZoom attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the theme is rendered or not

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the theme is rendered or not

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the theme is rendered or not This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the theme is rendered or not This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getRightClickBehavior

public java.lang.String getRightClickBehavior()

Description: Specifies the behavior when user right clicks on an element of a theme. Valid value of theme are: "Popup" - A popup will be shown. The content of the popup is defined in the rtPopup facet of the map "None" - Nothing will be done.

Returns:

the value of the rightClickBehavior attribute of the Tag this class represents.

setRightClickBehavior

public void setRightClickBehavior(java.lang.String rightClickBehavior)

Description: Specifies the behavior when user right clicks on an element of a theme. Valid value of theme are: "Popup" - A popup will be shown. The content of the popup is defined in the rtPopup facet of the map "None" - Nothing will be done.

Parameters:

rightClickBehavior - the value of the rightClickBehavior attribute of the Tag this class represents.

getSelectionListener

public java.lang.String getSelectionListener()

Description: a method reference to a selection listener Refers to a backing bean method that takes MapSelectionEvent as an argument. The MapSelectionEvent contains the information on the selected region. Sample code: public void processSelection(MapSelectionEvent mapSelectionEvent) { Iterator iterator = mapSelectionEvent.getIterator(); while (iterator.hasNext()) { DataContent dt = (DataContent)iterator.next(); String selectedLocation = dt.getLocationName(); System.out.println (selectedLocation); } }

Returns:

the value of the selectionListener attribute of the Tag this class represents.

setSelectionListener

public void setSelectionListener(java.lang.String selectionListener)

Description: a method reference to a selection listener Refers to a backing bean method that takes MapSelectionEvent as an argument. The MapSelectionEvent contains the information on the selected region. Sample code: public void processSelection(MapSelectionEvent mapSelectionEvent) { Iterator iterator = mapSelectionEvent.getIterator(); while (iterator.hasNext()) { DataContent dt = (DataContent)iterator.next(); String selectedLocation = dt.getLocationName(); System.out.println (selectedLocation); } }

Parameters:

selectionListener - the value of the selectionListener attribute of the Tag this class represents.

getShortLabel

public java.lang.String getShortLabel()

Description: Specifies the label of this theme on the legend. If the attribute is not specified, the id of the theme will be used as the label on the legend.

Returns:

the value of the shortLabel attribute of the Tag this class represents.

setShortLabel

public void setShortLabel(java.lang.String shortLabel)

Description: Specifies the label of this theme on the legend. If the attribute is not specified, the id of the theme will be used as the label on the legend.

Parameters:

shortLabel - the value of the shortLabel attribute of the Tag this class represents.

getThemeName

public java.lang.String getThemeName()

Description: Specifies the predefined theme on which this theme layer is based. The theme must come from the same data source as the base map. The theme is defined in mapbuilder. For detail, refer to the documentation of mapviewer.

Returns:

the value of the themeName attribute of the Tag this class represents.

setThemeName

public void setThemeName(java.lang.String themeName)

Description: Specifies the predefined theme on which this theme layer is based. The theme must come from the same data source as the base map. The theme is defined in mapbuilder. For detail, refer to the documentation of mapviewer.

Parameters:

themeName - the value of the themeName attribute of the Tag this class represents.

isUseWindow

public boolean isUseWindow()

Description: Specifies whether processes launched by this command should be launched in a secondary dialog window. 'useWindow' works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Set useWindow to 'false' for the dialog to be opened in the existing window.

Returns:

the value of the useWindow attribute of the Tag this class represents.

setUseWindow

public void setUseWindow(boolean useWindow)

Description: Specifies whether processes launched by this command should be launched in a secondary dialog window. 'useWindow' works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Set useWindow to 'false' for the dialog to be opened in the existing window.

Parameters:

useWindow - the value of the useWindow attribute of the Tag this class represents.

isUseWindowAsString

public java.lang.String isUseWindowAsString()

Description: Specifies whether processes launched by this command should be launched in a secondary dialog window. 'useWindow' works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Set useWindow to 'false' for the dialog to be opened in the existing window. This method is provided as a convenience to be able to retrieve an EL that was set on the useWindow attribute.

Returns:

the value of the useWindow attribute of the Tag this class represents.

setUseWindowAsString

public void setUseWindowAsString(java.lang.String useWindow)

Description: Specifies whether processes launched by this command should be launched in a secondary dialog window. 'useWindow' works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Set useWindow to 'false' for the dialog to be opened in the existing window. This method is provided as a convenience to be able to set an EL on the useWindow attribute.

Parameters:

useWindow - the value of the useWindow attribute of the Tag this class represents.

getWindowHeight

public int getWindowHeight()
                    throws java.lang.NumberFormatException

Description: Specifies the height of the window if useWindow is true

Returns:

the value of the windowHeight attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setWindowHeight

public void setWindowHeight(int windowHeight)

Description: Specifies the height of the window if useWindow is true

Parameters:

windowHeight - the value of the windowHeight attribute of the Tag this class represents.

getWindowHeightAsString

public java.lang.String getWindowHeightAsString()
                                         throws java.lang.NumberFormatException

Description: Specifies the height of the window if useWindow is true This method is provided as a convenience to be able to retrieve an EL that was set on the windowHeight attribute.

Returns:

the value of the windowHeight attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setWindowHeightAsString

public void setWindowHeightAsString(java.lang.String windowHeight)

Description: Specifies the height of the window if useWindow is true This method is provided as a convenience to be able to set an EL on the windowHeight attribute.

Parameters:

windowHeight - the value of the windowHeight attribute of the Tag this class represents.

getWindowWidth

public int getWindowWidth()
                   throws java.lang.NumberFormatException

Description: Specifies the width of the window if useWindow is true

Returns:

the value of the windowWidth attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setWindowWidth

public void setWindowWidth(int windowWidth)

Description: Specifies the width of the window if useWindow is true

Parameters:

windowWidth - the value of the windowWidth attribute of the Tag this class represents.

getWindowWidthAsString

public java.lang.String getWindowWidthAsString()
                                        throws java.lang.NumberFormatException

Description: Specifies the width of the window if useWindow is true This method is provided as a convenience to be able to retrieve an EL that was set on the windowWidth attribute.

Returns:

the value of the windowWidth attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setWindowWidthAsString

public void setWindowWidthAsString(java.lang.String windowWidth)

Description: Specifies the width of the window if useWindow is true This method is provided as a convenience to be able to set an EL on the windowWidth attribute.

Parameters:

windowWidth - the value of the windowWidth attribute of the Tag this class represents.