com.esri.aims.mtier.model.arcmap
Class DataFrame

java.lang.Object
  com.esri.aims.mtier.model.arcmap.DataFrame

All Implemented Interfaces:

Serializable

public class DataFrame
extends Object
implements Serializable

The DataFrame object represents one data frame from an ArcMap Server. The DataFrame object contains its own Java Connector model.

See Also:

Serialized Form

Constructor Summary

DataFrame()
Constructs an instance of a DataFrame object.

Method Summary

String	getID() Returns the DataFrame objects id value.
Map	getMap() Returns the DataFrame objects associated Map object.
boolean	isArcMapLayerVisible() Returns the flag for the ability to change layers visibility associated with a dataframe.
boolean	isArcMapScale() Returns the flag for the ability to change scale associated with dataframe.
boolean	isLayout() Returns whether the GET_LAYOUT request has DATAFRAME element
void	setArcMapLayerVisible(boolean value) Sets flag to change layers visibility associated with a dataframe.
void	setArcMapScale(boolean value) Sets the flag to change scale associated with dataframe.
void	setID(String value) Sets the ID of the DataFrame object.
void	setLayout(boolean value) Specifies to generate the DATAFRAME element inside GET_LAYOUT request.
void	setMap(Map obj) Assigns a Map object to the DataFrame object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFrame

public DataFrame()

Constructs an instance of a DataFrame object.

DataFrame dataFrame = new DataFrame();

Method Detail

setMap

public void setMap(Map obj)

Assigns a Map object to the DataFrame object.

 Map map = new Map();
 dataFrame.setMap(map);
 

Parameters:

obj - the Map object.

See Also:

getMap()

getMap

public Map getMap()

Returns the DataFrame objects associated Map object.

 Map map = dataFrame.getMap();
 

Returns:

Map

See Also:

setMap(com.esri.aims.mtier.model.map.Map)

setLayout

public void setLayout(boolean value)

Specifies to generate the DATAFRAME element inside GET_LAYOUT request.

   dataFrame.setLayout(true);
 

Parameters:

value - true to generate DATAFRAME element.

See Also:

isLayout()

isLayout

public boolean isLayout()

Returns whether the GET_LAYOUT request has DATAFRAME element

Returns:

the primitive boolean

See Also:

setLayout(boolean)

setArcMapScale

public void setArcMapScale(boolean value)

Sets the flag to change scale associated with dataframe. Sets true if changing Scale associated with dataframe.

isArcMapScale

public boolean isArcMapScale()

Returns the flag for the ability to change scale associated with dataframe.

setID

public void setID(String value)

Sets the ID of the DataFrame object. The ID references the ID from the ArcXML DataFrame elements id attribute.

 dataFrame.setID("2");
 

Parameters:

value - the ID value.

See Also:

getID()

getID

public String getID()

Returns the DataFrame objects id value.

 String id = dataFrame.getID();
 

Returns:

String

See Also:

setID(java.lang.String)

setArcMapLayerVisible

public void setArcMapLayerVisible(boolean value)

Sets flag to change layers visibility associated with a dataframe. Sets true if changing the layer visibility.

isArcMapLayerVisible

public boolean isArcMapLayerVisible()

Returns the flag for the ability to change layers visibility associated with a dataframe.