Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


oracle.adf.view.faces.bi.component.geoMap
Class ThemeFOI

java.lang.Object
  extended by oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      extended by oracle.adf.view.faces.bi.component.geoMap.ThemeFOI

All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
NSDPTheme, PointFOI, PredefinedThemeFOI

public abstract class ThemeFOI
extends BIComplexAttributeBase

This complex attributes class will display a theme on the map. This is the base class for ColorThemeFOI, BarChartThemeFOI, PieChartThemeFOI, PointFOI and PredefinedThemeFOI.


Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey CLICKACTION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLICKLISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INFOWINDOWCALLBACK_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LEFTCLICKBEHAVIOR_KEY
           
protected static oracle.adf.share.logging.ADFLogger logger
           
protected static java.lang.String LOGGERCLASS
           
static org.apache.myfaces.trinidad.bean.PropertyKey MAXZOOM_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MENULABEL_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MINZOOM_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey RENDERED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey RIGHTCLICKBEHAVIOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SELECTIONLISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORTLABEL_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey USEWINDOW_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOWHEIGHT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOWWIDTH_KEY
           

 

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY

 

Constructor Summary
ThemeFOI()
           

 

Method Summary
static int convertLeftClickBehavior(java.lang.String clickBehavior)
           
static int convertRightClickBehavior(java.lang.String clickBehavior)
           
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 javax.el.MethodExpression getClickAction()
           
 javax.el.MethodExpression getClickListener()
          Return the method expression that reference a clickListener
 java.lang.String[] getColorFromStyle(java.lang.String defaultStyle)
          Hidden
 javax.el.MethodExpression getInfoWindowCallback()
          Return the method expression that references to an infoWindowCallback
abstract  java.lang.String getInternalThemeType()
          Hidden
 int getLeftClickBehavior()
          Return the left click behavior for this theme
 int getMaxZoom()
          Return the maximum zoom scale where this theme will still be visible
 java.lang.String getMenuLabel()
          Return the label for this theme on the ThemeSelectionDialog and the Select menu Item
 int getMinZoom()
          Return the minimum zoom scale where the theme will still be visible
 oracle.adf.view.faces.bi.component.util.NumberFormat getNumberFormat()
          Hidden
 java.lang.Object getProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
          Hidden
 int getRightClickBehavior()
          Return the right click behavior for this theme
 javax.el.MethodExpression getSelectionListener()
           
 java.lang.String getShortLabel()
          Return the label for this theme on the legend
 java.lang.String getThemeClientSideLeftClickBehavior(UIGeoMap map)
          Hidden
 java.lang.String getThemeClientSideRightClickBehavior(UIGeoMap map)
          Hidden
 int getWindowHeight()
          Return the height of the window if useWindow is true
 int getWindowWidth()
          Return the width of the window if useWindow is true
 java.lang.Boolean isLoaded()
          Hidden
 boolean isNumberFormatSpecified()
          Hidden
 boolean isRendered()
          Indicates whether this theme is rendered or not
 java.lang.Boolean isToolbarVisible()
          Hidden
 boolean isUseWindow()
          Indicates whether to launch a secondary dialog window
 void setClickAction(javax.el.MethodExpression clickAction)
          Refers to a backing bean method that performs navigation processing for the map and returns an outcome String.
 void setClickListener(javax.el.MethodExpression clickActionListener)
          Specifies the method expression that reference a clickActionListener
 void setInfoWindowCallback(javax.el.MethodExpression callback)
          Return a method expression that references to an infoWindowCallback
 void setLeftClickBehavior(int leftClickBehavior)
          Specifies the behavior when user left clicks on an element of a theme.
 void setLoaded(java.lang.Boolean loaded)
          Hidden
 void setMaxZoom(int maxZoom)
          Specifies the maximum zoom scale where this theme will still be visible.
 void setMenuLabel(java.lang.String menuLabel)
          Specifies the label for this theme on the ThemeSelectionDialog and SelectMenuItem.
 void setMinZoom(int minZoom)
          Specifies the minimum zoom scale where the theme will still be visible.
 void setNumberFormat(oracle.adf.view.faces.bi.component.util.NumberFormat format)
          Hidden
 void setRendered(boolean bRendered)
          Specifies whether this theme is rendered or not
 void setRightClickBehavior(int rightClickBehavior)
          Specifies the behavior when user right clicks on an element of a theme.
 void setSelectionListener(javax.el.MethodExpression selectionListener)
          Specifies the method expression that references to a selectionListener
 void setShortLabel(java.lang.String shortLabel)
          Specifies the label for this theme on the legend.
 void setToolbarVisible(java.lang.Boolean bVisible)
          Hidden
 void setUseWindow(boolean bUseWindow)
          Specifies whether processes launched by this command should be launched in a secondary dialog window.
 void setWindowHeight(int winHeight)
          Specifies the height of the window if useWindow is true
 void setWindowWidth(int winWidth)
          Specifies the width of the window if useWindow is true

 

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getPropertyKey, isTransient, isUpdated, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

RENDERED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RENDERED_KEY

SHORTLABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORTLABEL_KEY

MENULABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MENULABEL_KEY

MINZOOM_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MINZOOM_KEY

MAXZOOM_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXZOOM_KEY

SELECTIONLISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTIONLISTENER_KEY

INFOWINDOWCALLBACK_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INFOWINDOWCALLBACK_KEY

CLICKACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLICKACTION_KEY

CLICKLISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLICKLISTENER_KEY

LEFTCLICKBEHAVIOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LEFTCLICKBEHAVIOR_KEY

RIGHTCLICKBEHAVIOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RIGHTCLICKBEHAVIOR_KEY

USEWINDOW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey USEWINDOW_KEY

WINDOWWIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOWWIDTH_KEY

WINDOWHEIGHT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOWHEIGHT_KEY

LOGGERCLASS

protected static java.lang.String LOGGERCLASS

logger

protected static oracle.adf.share.logging.ADFLogger logger

Constructor Detail

ThemeFOI

public ThemeFOI()

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Specified by:
getBeanType in class BIComplexAttributeBase

setMenuLabel

public void setMenuLabel(java.lang.String menuLabel)
Specifies the label for this theme on the ThemeSelectionDialog and SelectMenuItem. If the attribute is not specified, the id of the theme will be used.
Parameters:
menuLabel - The label for this theme on the ThemeSelectionDialog and the select menu item.

getMenuLabel

public java.lang.String getMenuLabel()
Return the label for this theme on the ThemeSelectionDialog and the Select menu Item
Returns:
The label for this theme on the ThemeSelectionDialog and the select menu item.

setShortLabel

public void setShortLabel(java.lang.String shortLabel)
Specifies the label for 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 label for this theme on the legend.

getShortLabel

public java.lang.String getShortLabel()
Return the label for this theme on the legend
Returns:
The label for this theme on the legend

setMinZoom

public void setMinZoom(int minZoom)
Specifies the minimum zoom scale where the theme will still be visible.
Parameters:
minZoom - The minimum zoom scale where the theme will still be visible.

getMinZoom

public int getMinZoom()
Return the minimum zoom scale where the theme will still be visible
Returns:
The minimum zoom scale where theme theme will still be visible

setMaxZoom

public void setMaxZoom(int maxZoom)
Specifies the maximum zoom scale where this theme will still be visible.
Parameters:
maxZoom - The maximum zoom scale where this theme will still be visible.

getMaxZoom

public int getMaxZoom()
Return the maximum zoom scale where this theme will still be visible
Returns:
The maximum zoom scale where this theme wll still be visible

setWindowWidth

public void setWindowWidth(int winWidth)
Specifies the width of the window if useWindow is true
Parameters:
winWidth - The width of the window if useWindow is true

getWindowWidth

public int getWindowWidth()
Return the width of the window if useWindow is true
Returns:
The width of the window if useWindow is true

setWindowHeight

public void setWindowHeight(int winHeight)
Specifies the height of the window if useWindow is true
Parameters:
winHeight - The height of the window if useWindow is true

getWindowHeight

public int getWindowHeight()
Return the height of the window if useWindow is true
Returns:
The height of the window if useWindow is true

setRendered

public void setRendered(boolean bRendered)
Specifies whether this theme is rendered or not
Parameters:
bRendered - True if this theme is rendered, False if it is not

isRendered

public boolean isRendered()
Indicates whether this theme is rendered or not
Returns:
True if this theme is rendered, false if it is not

setUseWindow

public void setUseWindow(boolean bUseWindow)
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:
bUseWindow - True if this command should launch a secondary dialog widow. False, Otherwise.

isUseWindow

public boolean isUseWindow()
Indicates whether to launch a secondary dialog window
Returns:
True if the command should launch a secondary dialog window. False, Otherwise.

getClickAction

public final javax.el.MethodExpression getClickAction()
Returns:

setClickAction

public final void setClickAction(javax.el.MethodExpression clickAction)
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 - A method expression that reference a clickAction

getClickListener

public final javax.el.MethodExpression getClickListener()
Return the method expression that reference a clickListener
Returns:
the method expression that reference a clickListener

setClickListener

public final void setClickListener(javax.el.MethodExpression clickActionListener)
Specifies the method expression that reference a clickActionListener
Parameters:
clickActionListener - The method expression that reference a clickActionListener

getSelectionListener

public final javax.el.MethodExpression getSelectionListener()

setSelectionListener

public final void setSelectionListener(javax.el.MethodExpression selectionListener)
Specifies the method expression that references to a selectionListener
Parameters:
selectionListener - The method expression that references a selectionListener

getInfoWindowCallback

public final javax.el.MethodExpression getInfoWindowCallback()
Return the method expression that references to an infoWindowCallback
Returns:
The method expression that references to an infoWindowCallback

setInfoWindowCallback

public final void setInfoWindowCallback(javax.el.MethodExpression callback)
Return a method expression that references to an infoWindowCallback
Parameters:
callback - The method expression that references to an infoWindowCallback

setLeftClickBehavior

public void setLeftClickBehavior(int leftClickBehavior)
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 behavior when user left clicks on an element of a theme.

getLeftClickBehavior

public int getLeftClickBehavior()
Return the left click behavior for this theme
Returns:
The leftClickBehavior of this theme

setRightClickBehavior

public void setRightClickBehavior(int rightClickBehavior)
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 behavior when user right clicks on an element of this theme.

getRightClickBehavior

public int getRightClickBehavior()
Return the right click behavior for this theme
Returns:
The right click behavior for this theme

setToolbarVisible

public void setToolbarVisible(java.lang.Boolean bVisible)
Hidden
For internal use only. Application developers should not use this

isToolbarVisible

public java.lang.Boolean isToolbarVisible()
Hidden
For internal use only. Application developers should not use this

setLoaded

public void setLoaded(java.lang.Boolean loaded)
Hidden
For internal use only. Application developers should not use this

isLoaded

public java.lang.Boolean isLoaded()
Hidden
For internal use only. Application developers should not use this

getNumberFormat

public oracle.adf.view.faces.bi.component.util.NumberFormat getNumberFormat()
Hidden
For internal use only. Application developers should not use this

isNumberFormatSpecified

public boolean isNumberFormatSpecified()
Hidden
For internal use only. Application developers should not use this

setNumberFormat

public void setNumberFormat(oracle.adf.view.faces.bi.component.util.NumberFormat format)
Hidden
For internal use only. Application developers should not use this

getColorFromStyle

public java.lang.String[] getColorFromStyle(java.lang.String defaultStyle)
Hidden
For internal use only. Application developers should not use this

getThemeClientSideRightClickBehavior

public java.lang.String getThemeClientSideRightClickBehavior(UIGeoMap map)
Hidden
For internal use only. Application developers should not use this

getThemeClientSideLeftClickBehavior

public java.lang.String getThemeClientSideLeftClickBehavior(UIGeoMap map)
Hidden
For internal use only. Application developers should not use this

getInternalThemeType

public abstract java.lang.String getInternalThemeType()
Hidden
For internal use only. Application developers should not use this

getProperty

public java.lang.Object getProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
Hidden
Overrides:
getProperty in class BIComplexAttributeBase
For internal use only. Application developers should not use this

convertLeftClickBehavior

public static final int convertLeftClickBehavior(java.lang.String clickBehavior)

convertRightClickBehavior

public static final int convertRightClickBehavior(java.lang.String clickBehavior)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


Copyright © 1997, 2008, Oracle. All rights reserved.