com.esri.adf.web.ags.data.edit.bean
Class ConfigBean

java.lang.Object
  com.esri.adf.web.ags.data.edit.bean.ConfigBean

All Implemented Interfaces:

Serializable

public class ConfigBean
extends Object
implements Serializable

ConfigBean is a backing bean, which defines the properties of the editing user interface. It can be instantiated from a face-config.xml.

 <managed-bean>
   <managed-bean-name>edit1</managed-bean-name>
   <managed-bean-class>com.esri.adf.web.ags.data.edit.bean.EditBean</managed-bean-class>
   <managed-bean-scope>none</managed-bean-scope>
   <managed-property>
     <property-name>taskConfig</property-name>
     <value>#{taskConfig1}</value>
   </managed-property>
 </managed-bean>
 
 <managed-bean>
   <managed-bean-name>taskConfig1</managed-bean-name>
   <managed-bean-class>com.esri.adf.web.ags.data.edit.bean.ConfigBean</managed-bean-class>
   <managed-bean-scope>none</managed-bean-scope>
   ...
 

The properties of the config bean can be defined using the ArcGIS Java Manger. The manager will generate the face-config.xml when creating a web application. You can change the face-config.xml to override those settings in the runtime.

See Also:

Serialized Form

Constructor Summary

ConfigBean()

Method Summary

String	getConfigName() Gets the configName of the ConfigBean.
String	getConflictMode() Gets reconcile rules.
String	getConflictWin() Gets reconcile rules.
com.esri.arcgisws.RgbColor	getHighlightColor() Gets the highlight color as a three element String array.
String	getHlColor() Gets the highlight color.
String	getLayers() Gets the editable layers.
Set<Integer>	getLayerSet() Gets the layers as a Set.
int	getMaxSelectionCount() Gets the maxSelectionCount of the ConfigBean.
GISResource	getResource() Gets the Map Service for the editing bean.
String	getResourceId() Gets the ID of the Map Resource.
String	getSdLayers() Gets snapping layers.
String	getSeLayers() Gets snapping layers.
String	getSnapTipsColor() Gets the snapTipsColor of the EditingBean.
int	getSnapTolerance() Gets the snapping tolerance in pixels.
String	getSvLayers() Gets snapping layers.
String	getTaskName() Deprecated. Please use EditBean.getTaskName().
int	getTolerance() Gets the search tolerance in pixels.
String	getVersions() Gets the editable versions.
Set<String>	getVersionSet() Gets the versions as a set.
String	getVerticesColor() Gets the color of vertices.
WebSimpleMarkerSymbol	getVerticesMarker() Gets the symbol to draw the vertices.
String	getVerticesOutline() Gets the outline color of vertices, e.g."255,255,0"
int	getVerticesShape() Gets the shape of vertex.
int	getVerticesSize() Gets the size of vertex.
String	getWorkspaceID() A workspace ID is a unique ID of workspace.
boolean	isAddFeatures() Returns true if Add Features function is enabled.
Boolean	isChildWin() Returns true to if the reconcile policy is child win.
Boolean	isColumnLevel() Returns true to if the reconcile policy is on column level.
boolean	isEditAttributes() Returns true when Edit Feature Attributes function is enable.
boolean	isEditFeatures() Returns true when Features Editing functions are enabled.
boolean	isSilentClearSketch() Returns true to clear sketch without the confirm window.
void	setAddFeatures(boolean addFeatures) Sets to true to enable Add Features function.
void	setConfigName(String configName) Sets the configName of the ConfigBean.
void	setConflictMode(String conflictMode) Sets reconcile rules.
void	setConflictWin(String conflictWin) Sets reconcile rules.
void	setEditAttributes(boolean editAttributes) Sets to true to enable Edit Feature Attributes function.
void	setEditFeatures(boolean editFeatures) Sets to true to enable Features Editing Functions, which include move, delete, copy, and modify features.
void	setHlColor(String hlColor) Sets the highlight color.
void	setLayers(String layers) Sets the editable layers.
void	setMaxSelectionCount(int maxSelectionCount) Sets the maxSelectionCount of the ConfigBean.
void	setResource(GISResource resource) Sets a Map Service for the editing bean.
void	setResourceId(String resourceId) Sets the ID of the Map Resource.
void	setSdLayers(String sdLayers) Sets snapping layers.
void	setSeLayers(String seLayers) Sets snapping layers.
void	setSilentClearSketch(boolean silentClearSketch) Sets to true to clear sketch without the confirm window.
void	setSnapTipsColor(String snapTipsColor) Sets the snapTipsColor of the EditingBean.
void	setSnapTolerance(int snapTolerance) Sets the snapping tolerance in pixels.
void	setSvLayers(String svLayers) Sets snapping layers.
void	setTaskName(String taskName) Deprecated. Please use EditBean.setTaskName(String).
void	setTolerance(int tolerance) Sets the search tolerance in pixels.
void	setVersions(String versions) Sets the editable versions.
void	setVerticesColor(String color) Sets the color of vertices.
void	setVerticesOutline(String verticesOutline) Sets the outline color of vertices, e.g."255,255,0"
void	setVerticesShape(int verticesShape) Sets the shape of vertex.
void	setVerticesSize(int verticesSize) Sets the size of vertex.
void	setWorkspaceID(String workspaceID) A workspace ID is a unique ID of workspace.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigBean

public ConfigBean()

Method Detail

setResource

public void setResource(GISResource resource)

Sets a Map Service for the editing bean.

Parameters:

resource - a map service instance.

getResource

public GISResource getResource()

Gets the Map Service for the editing bean.

Returns:

the map service.

getLayers

public String getLayers()

Gets the editable layers. Only those layers can be edited by the editing Bean.

Returns:

a set of layer ID delimited by semicolon, e.g. 2;5;

setLayers

public void setLayers(String layers)

Sets the editable layers. Only those layers can be edited by the editing bean.

Parameters:

layers - a set of layer ID delimited by semicolon, e.g. 2;5;

getResourceId

public String getResourceId()

Gets the ID of the Map Resource.

setResourceId

public void setResourceId(String resourceId)

Sets the ID of the Map Resource.

Parameters:

resourceId - a map service id, e.g. agsResource1

getTaskName

public String getTaskName()

Deprecated. Please use EditBean.getTaskName().

Gets the name of the bean. It will be showed as bean windows title.

Returns:

the bean name.

setTaskName

public void setTaskName(String taskName)

Deprecated. Please use EditBean.setTaskName(String).

Sets the name of the Bean. It will be showed as bean windows title.

Parameters:

taskName - the bean name.

getConfigName

public String getConfigName()

Gets the configName of the ConfigBean.

Returns:

Returns the configName.

setConfigName

public void setConfigName(String configName)

Sets the configName of the ConfigBean.

Parameters:

configName - The configName to set.

getVersions

public String getVersions()

Gets the editable versions. For version based editing, only the versions listed here are editable for the users. For none versioned based editing, it can be null or "".

Returns:

a set of version names delimited by semicolon. e.g. "sde.default;USER_NAME.VERSION;"

setVersions

public void setVersions(String versions)

Sets the editable versions. For version based editing, only the versions listed here are editable for the users. For none versioned based editing, it can be null or "".

Parameters:

versions - a set of version names delimited by semicolon.

getWorkspaceID

public String getWorkspaceID()

A workspace ID is a unique ID of workspace. The manager creates this ID during the bean configuration. The editing bean will pick up the workspace based on this ID in the runtime.

Returns:

the workspace ID, e.g. SDE.DEFAULT (PASSWORD@MACHINE_NAME:PORT_NUMBER)

setWorkspaceID

public void setWorkspaceID(String workspaceID)

A workspace ID is a unique ID of workspace. The manager creates this ID during the bean configuration. The editing bean will pick up the workspace based on this ID in the runtime.

Parameters:

workspaceID - a ID, e.g. SDE.DEFAULT (PASSWORD@MACHINE_NAME:PORT_NUMBER)

isAddFeatures

public boolean isAddFeatures()

Returns true if Add Features function is enabled.

Returns:

Returns true if Add Features function is enabled.

setAddFeatures

public void setAddFeatures(boolean addFeatures)

Sets to true to enable Add Features function.

Parameters:

addFeatures - Sets to true to enable Add Features function.

isEditAttributes

public boolean isEditAttributes()

Returns true when Edit Feature Attributes function is enable.

Returns:

Returns true when Edit Attributes function is enable.

setEditAttributes

public void setEditAttributes(boolean editAttributes)

Sets to true to enable Edit Feature Attributes function.

Parameters:

editAttributes -

isEditFeatures

public boolean isEditFeatures()

Returns true when Features Editing functions are enabled. Features Editing functions include move, delete, copy, and modify features.

Returns:

Returns true when Features Editing functions are enabled.

setEditFeatures

public void setEditFeatures(boolean editFeatures)

Sets to true to enable Features Editing Functions, which include move, delete, copy, and modify features.

Parameters:

editFeatures - sets to true to enable Features Editing Functions.

getHlColor

public String getHlColor()

Gets the highlight color. It is a string stand for R(0-255),G(0-255),B(0-255) values, e.g. "255,0,0"

Returns:

the highlight color, e.g. 255,0,0

setHlColor

public void setHlColor(String hlColor)

Sets the highlight color. It is a string stand for R(0-255),G(0-255),B(0-255) values, e.g. "255,0,0"

Parameters:

hlColor - the highlight color, e.g. "255,0,0"

getSnapTolerance

public int getSnapTolerance()

Gets the snapping tolerance in pixels.

Returns:

the snapping tolerance in pixels.

setSnapTolerance

public void setSnapTolerance(int snapTolerance)

Sets the snapping tolerance in pixels.

Parameters:

snapTolerance - the snapping tolerance in pixels.

getTolerance

public int getTolerance()

Gets the search tolerance in pixels.

Returns:

the search tolerance in pixels.

setTolerance

public void setTolerance(int tolerance)

Sets the search tolerance in pixels.

Parameters:

tolerance - the search tolerance in pixels.

getVerticesColor

public String getVerticesColor()

Gets the color of vertices. It is a string stand for R(0-255),G(0-255),B(0-255) values, e.g. "255,0,0"

Returns:

the color of vertices, e.g. "255,0,0"

setVerticesColor

public void setVerticesColor(String color)

Sets the color of vertices. It is a string stand for R(0-255),G(0-255),B(0-255) values, e.g. "255,0,0"

Parameters:

color - the color of vertices, e.g. "255,0,0"

getSdLayers

public String getSdLayers()

Gets snapping layers. There are 3 types of snapping, this setting is for edge snapping.

Returns:

a set of layers ID delimited by semicolon, e.g. 2;3;

setSdLayers

public void setSdLayers(String sdLayers)

Sets snapping layers. There are 3 types of snapping, this setting is for edge snapping.

Parameters:

sdLayers - a set of layers ID delimited by semicolon, e.g. 2;3;

getSeLayers

public String getSeLayers()

Gets snapping layers. There are 3 types of snapping, this setting is for end snapping.

Returns:

a set of layers ID delimited by semicolon, e.g. 2;3;

setSeLayers

public void setSeLayers(String seLayers)

Sets snapping layers. There are 3 types of snapping, this setting is for end snapping.

Parameters:

seLayers - a set of layers ID delimited by semicolon, e.g. 2;3;

getSvLayers

public String getSvLayers()

Gets snapping layers. There are 3 types of snapping, this setting is for vertex snapping.

Returns:

a set of layers ID delimited by semicolon, e.g. 2;3;

setSvLayers

public void setSvLayers(String svLayers)

Sets snapping layers. There are 3 types of snapping, this setting is for vertex snapping.

Parameters:

svLayers - a set of layers ID delimited by semicolon, e.g. 2;3;

getConflictMode

public String getConflictMode()

Gets reconcile rules. Possible values are "0" or "1".

Returns:

"0" or "1".

setConflictMode

public void setConflictMode(String conflictMode)

Sets reconcile rules. Available values are "0" or "1". Set to "0" for parent win or "1" for child win.

Parameters:

conflictMode - "0" or "1".

getConflictWin

public String getConflictWin()

Gets reconcile rules. Possible values are "0" or "1".

setConflictWin

public void setConflictWin(String conflictWin)

Sets reconcile rules. Available values are "0" or "1". Set to "0" for row level or "1" for column level.

Parameters:

conflictWin - "0" or "1"

getVerticesOutline

public String getVerticesOutline()

Gets the outline color of vertices, e.g."255,255,0"

setVerticesOutline

public void setVerticesOutline(String verticesOutline)

Sets the outline color of vertices, e.g."255,255,0"

Parameters:

verticesOutline -

getMaxSelectionCount

public int getMaxSelectionCount()

Gets the maxSelectionCount of the ConfigBean.

Returns:

Returns the maxSelectionCount.

setMaxSelectionCount

public void setMaxSelectionCount(int maxSelectionCount)

Sets the maxSelectionCount of the ConfigBean.

Parameters:

maxSelectionCount - The maxSelectionCount to set.

getVerticesShape

public int getVerticesShape()

Gets the shape of vertex.

setVerticesShape

public void setVerticesShape(int verticesShape)

Sets the shape of vertex. Check com.esri.adf.web.data.symbol.WebSimpleMarkerSymbol for supported values. The default value is WebSimpleMarkerSymbol.SQUARE.

Parameters:

verticesShape -

getVerticesSize

public int getVerticesSize()

Gets the size of vertex. Default value is 8.

setVerticesSize

public void setVerticesSize(int verticesSize)

Sets the size of vertex. Default value is 8.

Parameters:

verticesSize -

getVerticesMarker

public WebSimpleMarkerSymbol getVerticesMarker()

Gets the symbol to draw the vertices.

getLayerSet

public Set<Integer> getLayerSet()

Gets the layers as a Set.

getVersionSet

public Set<String> getVersionSet()

Gets the versions as a set.

getHighlightColor

public com.esri.arcgisws.RgbColor getHighlightColor()
                                             throws NumberFormatException

Gets the highlight color as a three element String array.

Throws:

NumberFormatException

isChildWin

public Boolean isChildWin()

Returns true to if the reconcile policy is child win.

isColumnLevel

public Boolean isColumnLevel()

Returns true to if the reconcile policy is on column level.

getSnapTipsColor

public String getSnapTipsColor()

Gets the snapTipsColor of the EditingBean.

Returns:

Returns the snapTipsColor.

setSnapTipsColor

public void setSnapTipsColor(String snapTipsColor)

Sets the snapTipsColor of the EditingBean.

Parameters:

snapTipsColor - The snapTipsColor to set.

isSilentClearSketch

public boolean isSilentClearSketch()

Returns true to clear sketch without the confirm window.

Returns:

Returns true to clear sketch without the confirm window.

setSilentClearSketch

public void setSilentClearSketch(boolean silentClearSketch)

Sets to true to clear sketch without the confirm window.

Parameters:

silentClearSketch - Sets to true to clear sketch without the confirm window.