EchoPoint API - 3.0.0b5
App Webcontainer

echopoint.google.chart
Class Map

java.lang.Object
  extended by nextapp.echo.app.Component
      extended by echopoint.internal.AbstractContainer
          extended by echopoint.google.chart.internal.AbstractChart<Integer>
              extended by echopoint.google.chart.Map
All Implemented Interfaces:
Serializable, RenderIdSupport

public class Map
extends AbstractChart<Integer>

Component wrapper for a Map provided by Google Chart API.

The following code shows sample use of this component:

   import echopoint.google.chart.Map;
   import echopoint.google.chart.model.ChartData;

     ...
     final ChartData<Integer> data = new ChartData<Integer>();
     final Integer[] array = new Integer[] { 0, 5, 9 };
     data.setXdata( Arrays.asList( array ) );

     final Map chart = new Map();
     final ArrayList<ChartData<Integer>> collection = new ArrayList<ChartData<Integer>>();
     collection.add( data );
     chart.setData( collection );
     chart.setCodes( "MGKETN" );
 

Version:
$Id: Map.java 83 2008-11-08 19:32:18Z sptrakesh $
Author:
Rakesh Vidyadharan 2008-08-25
See Also:
Serialized Form

Nested Class Summary
static class Map.Regions
          An enumeration used to represent the regions supported by the map.
 
Field Summary
static String PROPERTY_CODES
          The property used to configure the countries or states in the map that are to be coloured.
static String PROPERTY_COLORS
          The property used to specify colour and colour gradients for countries or states displayed in the map.
static String PROPERTY_GEOGRAPHICAL_AREA
          The property used to configure the map area.
 
Fields inherited from class echopoint.google.chart.internal.AbstractChart
PROPERTY_ALT, PROPERTY_DATA, PROPERTY_FILL, PROPERTY_TITLE
 
Fields inherited from class echopoint.internal.AbstractContainer
ACTION_COMMAND_PROPERTY, ACTION_LISTENERS_CHANGED_PROPERTY, INPUT_ACTION, PROPERTY_ALIGNMENT, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_HEIGHT, PROPERTY_INSETS, PROPERTY_WIDTH
 
Fields inherited from class nextapp.echo.app.Component
CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY
 
Constructor Summary
Map()
           
 
Method Summary
 String getCodes()
          Return the PROPERTY_CODES property value.
 String getColors()
          Return the PROPERTY_COLORS property value.
 Map.Regions getGeographicalArea()
          Return the PROPERTY_GEOGRAPHICAL_AREA property value.
 void setCodes(String codes)
          Set the value of the PROPERTY_CODES property.
 void setColors(String colors)
          Set the value of the PROPERTY_COLORS property.
 void setGeographicalArea(Map.Regions region)
          Set the value of the PROPERTY_GEOGRAPHICAL_AREA property.
 
Methods inherited from class echopoint.google.chart.internal.AbstractChart
getAlt, getData, getFill, getTitle, isValidChild, setAlt, setData, setData, setFill, setTitle
 
Methods inherited from class echopoint.internal.AbstractContainer
addActionListener, fireActionPerformed, getAlignment, getBackgroundImage, getBorder, getHeight, getInsets, getWidth, hasActionListeners, removeActionListener, setAlignment, setBackgroundImage, setBorder, setHeight, setInsets, setWidth
 
Methods inherited from class nextapp.echo.app.Component
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_GEOGRAPHICAL_AREA

public static final String PROPERTY_GEOGRAPHICAL_AREA
The property used to configure the map area. This property may be styled.

See Also:
Constant Field Values

PROPERTY_COLORS

public static final String PROPERTY_COLORS
The property used to specify colour and colour gradients for countries or states displayed in the map. Colour specifications are different for maps as compared to regular charts. This property is best styled.

See Also:
Constant Field Values

PROPERTY_CODES

public static final String PROPERTY_CODES
The property used to configure the countries or states in the map that are to be coloured. This property may be styled.

See Also:
Constant Field Values
Constructor Detail

Map

public Map()
Method Detail

getGeographicalArea

public Map.Regions getGeographicalArea()
Return the PROPERTY_GEOGRAPHICAL_AREA property value.

Returns:
The value that indicates the chart dimensions.

setGeographicalArea

public void setGeographicalArea(Map.Regions region)
Set the value of the PROPERTY_GEOGRAPHICAL_AREA property.

Parameters:
region - The value to set.

getColors

public String getColors()
Return the PROPERTY_COLORS property value.

Returns:
The colors value encoded as required by the chart api.

setColors

public void setColors(String colors)
Set the value of the PROPERTY_COLORS property.

Parameters:
colors - The value to set.

getCodes

public String getCodes()
Return the PROPERTY_CODES property value.

Returns:
The codes value encoded as required by the chart api.

setCodes

public void setCodes(String codes)
Set the value of the PROPERTY_CODES property.

Parameters:
codes - The value to set.

EchoPoint API - 3.0.0b5
App Webcontainer