Table Of Contents

Previous topic

gxp.plugins.Print

Next topic

gxp.plugins.RemoveLayer

gxp.plugins.QueryForm

Extends
ptype
gxp_queryform
class gxp.plugins.QueryForm(config)

Plugin for performing queries on feature layers TODO Replace this tool with something that is less like GeoEditor and more like filtering.

Config Options

Configuration properties in addition to those listed for Ext.util.Observable.

actions

Object By default, this tool creates a “Query” action to trigger the output of this tool’s form. Set to null if you want to include the form permanently in your layout.

actionTarget

Object or String or Array Where to place the tool’s actions (e.g. buttons or menus)?

In case of a string, this can be any string that references an Ext.Container property on the portal, or a unique id configured on a component.

In case of an object, the object has a “target” and an “index” property, so that the tool can be inserted at a specified index in the target.

actionTarget can also be an array of strings or objects, if the action is to be put in more than one place (e.g. a button and a context menu item).

To reference one of the toolbars of an Ext.Panel, ”.tbar”, ”.bbar” or ”.fbar” has to be appended. The default is “map.tbar”. The viewer’s main MapPanel can always be accessed with “map” as actionTarget. Set to null if no actions should be created.

Some tools provide a context menu. To reference this context menu as actionTarget for other tools, configure an id in the tool’s outputConfig, and use the id with ”.contextMenu” appended. In the snippet below, a layer tree is created, with a “Remove layer” action as button on the tree’s top toolbar, and as menu item in its context menu:

{
    xtype: "gxp_layertree",
    outputConfig: {
        id: "tree",
        tbar: []
    }
}, {
    xtype: "gxp_removelayer",
    actionTarget: ["tree.tbar", "tree.contextMenu"]
}

If a tool has both actions and output, and you want to force it to immediately output to a container, set actionTarget to null. If you want to hide the actions, set actionTarget to false. In this case, you should configure a defaultAction to make sure that an action is active.

autoActivate

Boolean Set to false if the tool should be initialized without activating it. Default is true.

autoExpand

String If set to the id of a container, the container will be expanded when the Query Form is enabled, and collapsed when it is disabled. Once the user manually expands/collapses the contaienr, the user setting will stick for the current session.

autoHide

Boolean Set to true if the output of this tool goes into an Ext.Window that should be hidden when the query result is available. Default is false.

cancelButtonText

String Text for cancel button (i18n).

controlOptions

Object If this tool is associated with an OpenLayers.Control then this is an optional object to pass to the constructor of the associated OpenLayers.Control.

defaultAction

Number Optional index of an action that should be active by default. Only works for actions that are a GeoExt.Action instance.

featureManager

String The id of the gxp.plugins.FeatureManager to use with this tool.

noFeaturesMsg

String Text for no features alert message (i18n)

noFeaturesTitle

String Text for no features alert title (i18n)

outputAction

Number By default, the “Query” action will trigger this tool’s form output. There is no need to change this unless you configure custom actions.

outputConfig

Object Optional configuration for the output container. This may be useful to override the xtype (e.g. “window” instead of “gx_popup”), or to provide layout configurations when rendering to an outputTarget.

outputTarget

String Where to add the tool’s output container? This can be any string that references an Ext.Container property on the portal, or “map” to access the viewer’s main map. If not provided, a window will be created. To reference one of the toolbars of an Ext.Panel, ”.tbar”, ”.bbar” or ”.fbar” has to be appended.

queryActionText

String Text for query action (i18n).

queryActionTip

String Text for query action tooltip (i18n).

queryByAttributesText

String Text for query by attributes (i18n).

queryByLocationText

String Text for query by location (i18n).

queryMenuText

String Text for query menu item (i18n).

queryMsg

String Text for query load mask (i18n).

showButtonText

Show the buttonText an action is configured with, if used as a button. Default is false.

toggleGroup

String If this tool should be radio-button style toggled with other tools, this string is to identify the toggle group.

Public Properties

Public properties in addition to those listed for Ext.util.Observable.

QueryForm.active

Boolean Is the tool currently active?

Public Methods

Public methods in addition to those listed for Ext.util.Observable.

QueryForm.activate()
Returns:Boolean true when this tool was activated

Activates this tool.

QueryForm.addActions()
QueryForm.addOutput()
QueryForm.deactivate()
Returns:Boolean true when this tool was deactivated

Deactivates this tool.

QueryForm.getState()

:return {Object} Gets the configured tool state. Overwrite in subclasses to return anything other than a copy of the initialConfig property.

QueryForm.removeOutput()

Removes all output created by this tool

Events

Events in addition to those listed for Ext.util.Observable.

activate

Fired when the tool is activated.

Listener arguments: * tool - gxp.plugins.Tool the activated tool

deactivate

Fired when the tool is deactivated.

Listener arguments: * tool - gxp.plugins.Tool the deactivated tool