com.esri.adf.web.data.tasks
Class ButtonDescriptor

java.lang.Object
  java.beans.FeatureDescriptor
      com.esri.adf.web.data.tasks.ButtonDescriptor

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TaskActionDescriptor, TaskToolDescriptor

public class ButtonDescriptor
extends java.beans.FeatureDescriptor
implements java.io.Serializable

The ButtonDescriptor is an intermediary class and its primary purpose is to serve as a super-class with basic implementations for some methods for the TaskActionDescriptor and TaskToolDescriptor classes.

See Also:

Serialized Form

Field Summary

protected java.lang.String	defaultImage The default image URL for the button.
protected boolean	disabled If true, the button will be disabled in the task UI
protected java.lang.String	disabledImage The disabled image URL for the button.
protected java.lang.String	hoverImage The hover image URL for the button.
static java.lang.String	IMAGE_RENDERER_TYPE The image-only renderer type.
static java.lang.String	IMAGEANDTEXT_RENDERER_TYPE The image-and-text renderer type.
protected java.lang.String	rendererType The renderer type of this parameter.
protected java.lang.String	selectedImage The selected image URL for the button.
protected boolean	showLoadingImage If true, a loading image will be displayed while the action / tool is being processed.
protected java.lang.String	style The CSS style to be applied to the button.
protected java.lang.String	styleClass The CSS style class to be applied to the button.
static java.lang.String	TEXT_RENDERER_TYPE The text-only renderer type.
protected java.lang.String	toolTip The tooltip text for the button.

Constructor Summary

ButtonDescriptor()

Method Summary

protected void	generateButtonXML(org.w3c.dom.Element element) Generates the XML content for this button.
java.lang.String	getDefaultImage() Returns the default image URL for the button
java.lang.String	getDisabledImage() Returns the disabled image URL for the button
java.lang.String	getHoverImage() Returns the hover image URL for the button
java.lang.String	getRendererType() Returns the renderer type of this parameter
java.lang.String	getSelectedImage() Returns the selected image URL for the button
java.lang.String	getStyle() Returns the CSS style to be applied to the button
java.lang.String	getStyleClass() Returns the CSS style class to be applied to the button
java.lang.String	getToolTip() Returns the tooltip text for the button
boolean	isDisabled() If true, the button will be disabled in the task UI
boolean	isShowLoadingImage() If true, a loading image will be displayed while the action / tool is being processed
void	setDefaultImage(java.lang.String defaultImage) Sets the default image URL for the button
void	setDisabled(boolean disabled) If set to true, the button will be disabled in the task UI
void	setDisabledImage(java.lang.String disabledImage) Returns the disabled image URL for the button
void	setHoverImage(java.lang.String hoverImage) Sets the hover image URL for the button
void	setRendererType(java.lang.String rendererType) Sets the renderer type of this parameter
void	setSelectedImage(java.lang.String selectedImage) Sets the selected image URL for the button
void	setShowLoadingImage(boolean showLoadingImage) If set to true, a loading image will be displayed while the action / tool is being processed
void	setStyle(java.lang.String style) Sets the CSS style to be applied to the button
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class to be applied to the button
void	setToolTip(java.lang.String toolTip) Sets the tooltip text for the button

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue

Methods inherited from class java.lang.Object

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

Field Detail

IMAGEANDTEXT_RENDERER_TYPE

public static final java.lang.String IMAGEANDTEXT_RENDERER_TYPE

The image-and-text renderer type. Buttons with this renderer type are displayed as image and text combined.

See Also:

Constant Field Values

TEXT_RENDERER_TYPE

public static final java.lang.String TEXT_RENDERER_TYPE

The text-only renderer type. Buttons with this renderer type are displayed as text.

See Also:

Constant Field Values

IMAGE_RENDERER_TYPE

public static final java.lang.String IMAGE_RENDERER_TYPE

The image-only renderer type. Buttons with this renderer type are displayed as images.

See Also:

Constant Field Values

style

protected java.lang.String style

The CSS style to be applied to the button.

styleClass

protected java.lang.String styleClass

The CSS style class to be applied to the button.

toolTip

protected java.lang.String toolTip

The tooltip text for the button.

defaultImage

protected java.lang.String defaultImage

The default image URL for the button. Note that this property is applicable only for image renderers

hoverImage

protected java.lang.String hoverImage

The hover image URL for the button. Note that this property is applicable only for image renderers

selectedImage

protected java.lang.String selectedImage

The selected image URL for the button. Note that this property is applicable only for image renderers

disabledImage

protected java.lang.String disabledImage

The disabled image URL for the button. Note that this property is applicable only for image renderers

disabled

protected boolean disabled

If true, the button will be disabled in the task UI

showLoadingImage

protected boolean showLoadingImage

If true, a loading image will be displayed while the action / tool is being processed.

rendererType

protected java.lang.String rendererType

The renderer type of this parameter. The default renderer is TEXT_RENDERER_TYPE

Constructor Detail

ButtonDescriptor

public ButtonDescriptor()

Method Detail

generateButtonXML

protected void generateButtonXML(org.w3c.dom.Element element)

Generates the XML content for this button. Sub-classes can call this method to generate the basic XML content for the button.

Parameters:

element - the XML Element for the content

getStyle

public java.lang.String getStyle()

Returns the CSS style to be applied to the button

Returns:

the CSS style to be applied to the button

setStyle

public void setStyle(java.lang.String style)

Sets the CSS style to be applied to the button

Parameters:

style - the CSS style to be applied to the button

getStyleClass

public java.lang.String getStyleClass()

Returns the CSS style class to be applied to the button

Returns:

the CSS style class to be applied to the button

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class to be applied to the button

Parameters:

styleClass - the CSS style class to be applied to the button

getToolTip

public java.lang.String getToolTip()

Returns the tooltip text for the button

Returns:

the tooltip text for the button

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the tooltip text for the button

Parameters:

toolTip - the tooltip text for the button

getDefaultImage

public java.lang.String getDefaultImage()

Returns the default image URL for the button

Returns:

the default image URL for the button

setDefaultImage

public void setDefaultImage(java.lang.String defaultImage)

Sets the default image URL for the button

Parameters:

defaultImage - the default image URL for the button

getHoverImage

public java.lang.String getHoverImage()

Returns the hover image URL for the button

Returns:

the hover image URL for the button

setHoverImage

public void setHoverImage(java.lang.String hoverImage)

Sets the hover image URL for the button

Parameters:

hoverImage - the hover image URL for the button

getSelectedImage

public java.lang.String getSelectedImage()

Returns the selected image URL for the button

Returns:

the selected image URL for the button

setSelectedImage

public void setSelectedImage(java.lang.String selectedImage)

Sets the selected image URL for the button

Parameters:

selectedImage - the selected image URL for the button

getDisabledImage

public java.lang.String getDisabledImage()

Returns the disabled image URL for the button

Returns:

the disabled image URL for the button

setDisabledImage

public void setDisabledImage(java.lang.String disabledImage)

Returns the disabled image URL for the button

Parameters:

disabledImage - the disabled image URL for the button

isDisabled

public boolean isDisabled()

If true, the button will be disabled in the task UI

Returns:

if true, the button will be disabled in the task UI

setDisabled

public void setDisabled(boolean disabled)

If set to true, the button will be disabled in the task UI

Parameters:

disabled - if true, the button will be disabled in the task UI

isShowLoadingImage

public boolean isShowLoadingImage()

If true, a loading image will be displayed while the action / tool is being processed

Returns:

if true, a loading image will be displayed while the action / tool is being processed

setShowLoadingImage

public void setShowLoadingImage(boolean showLoadingImage)

If set to true, a loading image will be displayed while the action / tool is being processed

Parameters:

showLoadingImage - if true, a loading image will be displayed while the action / tool is being processed

getRendererType

public java.lang.String getRendererType()

Returns the renderer type of this parameter

Returns:

the renderer type of this parameter

setRendererType

public void setRendererType(java.lang.String rendererType)

Sets the renderer type of this parameter

Parameters:

rendererType - the renderer type of this parameter