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

Class MapLegend

java.lang.Object

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

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

All Implemented Interfaces:

ExtendedProperties

public class MapLegend
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of an mapLegend.

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
MapLegend()

Method Summary

Methods

Modifier and Type	Method and Description
int	getHeight() Description: Specifies the height of legend.
java.lang.String	getHeightAsString() Description: Specifies the height of legend.
int	getNumberOfColumns() Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend.
java.lang.String	getNumberOfColumnsAsString() Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend.
java.lang.String	getPointThemeLabel() Description: Specifies the label for the point theme.
java.lang.String	getTagName()
int	getWidth() Description: Specifies the width of the legend.
java.lang.String	getWidthAsString() Description: Specifies the width of the legend.
boolean	isInitialShown() Description: Specifies whether the legend should be shown in a popup when the map starts.
java.lang.String	isInitialShownAsString() Description: Specifies whether the legend should be shown in a popup when the map starts.
boolean	isRendered() Description: Specifies whether the legend is rendered.
java.lang.String	isRenderedAsString() Description: Specifies whether the legend is rendered.
void	setHeight(int height) Description: Specifies the height of legend.
void	setHeightAsString(java.lang.String height) Description: Specifies the height of legend.
void	setInitialShown(boolean initialShown) Description: Specifies whether the legend should be shown in a popup when the map starts.
void	setInitialShownAsString(java.lang.String initialShown) Description: Specifies whether the legend should be shown in a popup when the map starts.
void	setNumberOfColumns(int numberOfColumns) Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend.
void	setNumberOfColumnsAsString(java.lang.String numberOfColumns) Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend.
void	setPointThemeLabel(java.lang.String pointThemeLabel) Description: Specifies the label for the point theme.
void	setRendered(boolean rendered) Description: Specifies whether the legend is rendered.
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the legend is rendered.
void	setWidth(int width) Description: Specifies the width of the legend.
void	setWidthAsString(java.lang.String width) Description: Specifies the width of the legend.

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

MapLegend

public MapLegend()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getHeight

public int getHeight()
              throws java.lang.NumberFormatException

Description: Specifies the height of legend. The default height is 150.

Returns:

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

Throws:

java.lang.NumberFormatException

setHeight

public void setHeight(int height)

Description: Specifies the height of legend. The default height is 150.

Parameters:

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

getHeightAsString

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

Description: Specifies the height of legend. The default height is 150. This method is provided as a convenience to be able to retrieve an EL that was set on the height attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setHeightAsString

public void setHeightAsString(java.lang.String height)

Description: Specifies the height of legend. The default height is 150. This method is provided as a convenience to be able to set an EL on the height attribute.

Parameters:

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

isInitialShown

public boolean isInitialShown()

Description: Specifies whether the legend should be shown in a popup when the map starts. The default value is false.

Returns:

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

setInitialShown

public void setInitialShown(boolean initialShown)

Description: Specifies whether the legend should be shown in a popup when the map starts. The default value is false.

Parameters:

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

isInitialShownAsString

public java.lang.String isInitialShownAsString()

Description: Specifies whether the legend should be shown in a popup when the map starts. The default value is false. This method is provided as a convenience to be able to retrieve an EL that was set on the initialShown attribute.

Returns:

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

setInitialShownAsString

public void setInitialShownAsString(java.lang.String initialShown)

Description: Specifies whether the legend should be shown in a popup when the map starts. The default value is false. This method is provided as a convenience to be able to set an EL on the initialShown attribute.

Parameters:

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

getNumberOfColumns

public int getNumberOfColumns()
                       throws java.lang.NumberFormatException

Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend. Developers can specify any number of colors for the colorTheme. For example, if a color theme has 15 colors, and the value of this attribute is 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns.

Returns:

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

Throws:

java.lang.NumberFormatException

setNumberOfColumns

public void setNumberOfColumns(int numberOfColumns)

Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend. Developers can specify any number of colors for the colorTheme. For example, if a color theme has 15 colors, and the value of this attribute is 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns.

Parameters:

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

getNumberOfColumnsAsString

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

Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend. Developers can specify any number of colors for the colorTheme. For example, if a color theme has 15 colors, and the value of this attribute is 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns. This method is provided as a convenience to be able to retrieve an EL that was set on the numberOfColumns attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setNumberOfColumnsAsString

public void setNumberOfColumnsAsString(java.lang.String numberOfColumns)

Description: Specifies the number of columns to use for displaying the colors of a color theme in the legend. Developers can specify any number of colors for the colorTheme. For example, if a color theme has 15 colors, and the value of this attribute is 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns. This method is provided as a convenience to be able to set an EL on the numberOfColumns attribute.

Parameters:

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

getPointThemeLabel

public java.lang.String getPointThemeLabel()

Description: Specifies the label for the point theme. All point themes are shown as one option on the drop down. This attribute let developers to change the label for the point theme. The default value is "Point Theme".

Returns:

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

setPointThemeLabel

public void setPointThemeLabel(java.lang.String pointThemeLabel)

Description: Specifies the label for the point theme. All point themes are shown as one option on the drop down. This attribute let developers to change the label for the point theme. The default value is "Point Theme".

Parameters:

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

isRendered

public boolean isRendered()

Description: Specifies whether the legend is rendered. The default value is true

Returns:

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

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the legend is rendered. The default value is true

Parameters:

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

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the legend is rendered. The default value is true 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 legend is rendered. The default value is true 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.

getWidth

public int getWidth()
             throws java.lang.NumberFormatException

Description: Specifies the width of the legend. The default width is 200.

Returns:

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

Throws:

java.lang.NumberFormatException

setWidth

public void setWidth(int width)

Description: Specifies the width of the legend. The default width is 200.

Parameters:

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

getWidthAsString

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

Description: Specifies the width of the legend. The default width is 200. This method is provided as a convenience to be able to retrieve an EL that was set on the width attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setWidthAsString

public void setWidthAsString(java.lang.String width)

Description: Specifies the width of the legend. The default width is 200. This method is provided as a convenience to be able to set an EL on the width attribute.

Parameters:

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