com.moximedia.aims
Class AimsWebSiteSelectSetOption

java.lang.Object
  extended bycom.moximedia.aims.AimsWebSiteSelectSetOption
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class AimsWebSiteSelectSetOption
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

An instance of the AimsWebSiteSelectSetMenuOption class is used to control the contents of the selected set result page.

Author:
Doug Cates - www.moximedia.com
See Also:
Serialized Form

Constructor Summary
AimsWebSiteSelectSetOption()
          Creates new AimsWebSiteSelectMenuType
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this object.
 AimsWebSiteSelectSetOption getCopy()
          Creates a copy of this object.
 java.lang.String getDescription()
          Gets the displayed description of the option.
 boolean getEnabled()
          Gets an indicator of whether the option is enabled.
 java.lang.String getSpinner()
          Gets the spinner (loadMap, loadData) shown when the option is executed.
 java.lang.String getTarget()
          Gets the target frame for the url of the option.
 java.lang.String getTitle()
          Gets the display title for the option.
 java.lang.String getUrl()
          Gets the url of the option.
 void setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value, java.lang.String xmlPath, java.lang.String imfPath)
          Sets one of the attributes of this object using a string value.
 void setDescription(java.lang.String description)
          Sets the display name of the option.
 void setSpinner(java.lang.String spinner)
          Gets the spinner (loadMap, loadData) shown when the option is executed.
 void setTarget(java.lang.String target)
          Sets the target frame for the url of the option.
 void setTitle(java.lang.String title)
          Sets the display title for the option.
 void setUrl(java.lang.String href)
          Sets the url of the option.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AimsWebSiteSelectSetOption

public AimsWebSiteSelectSetOption()
Creates new AimsWebSiteSelectMenuType

Method Detail

clone

public java.lang.Object clone()
Creates a copy of this object.

Returns:
An object that is a copy of this object. The object must be cast to the proper object type before use.

getCopy

public AimsWebSiteSelectSetOption getCopy()
Creates a copy of this object.

Returns:
An object that is a copy of this object.

getDescription

public java.lang.String getDescription()
Gets the displayed description of the option.

Returns:
The description to be displayed on the select menu.

setDescription

public void setDescription(java.lang.String description)
Sets the display name of the option.


getEnabled

public boolean getEnabled()
Gets an indicator of whether the option is enabled.

Returns:
True if the option is enabled, otherwise false.

getUrl

public java.lang.String getUrl()
Gets the url of the option.

Returns:
The url called when the link on the select menu is clicked.

setUrl

public void setUrl(java.lang.String href)
Sets the url of the option.

Parameters:
href - The url called when the link on the select menu is clicked.

getSpinner

public java.lang.String getSpinner()
Gets the spinner (loadMap, loadData) shown when the option is executed.

Returns:
The spinner name (loadMap, loadData) or "" if no spinner is used.

setSpinner

public void setSpinner(java.lang.String spinner)
Gets the spinner (loadMap, loadData) shown when the option is executed.

Parameters:
spinner - The spinner name (loadMap, loadData) or "" if no spinner is used.

getTarget

public java.lang.String getTarget()
Gets the target frame for the url of the option.

Returns:
The target frame for the url called when the link on the select menu is clicked.

setTarget

public void setTarget(java.lang.String target)
Sets the target frame for the url of the option.

Parameters:
target - The target frame for the url called when the link on the select menu is clicked.

getTitle

public java.lang.String getTitle()
Gets the display title for the option.

Returns:
The title for the option in the selected set summary page.

setTitle

public void setTitle(java.lang.String title)
Sets the display title for the option.

Parameters:
title - The title for the option in the selected set summary page.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value,
                            java.lang.String xmlPath,
                            java.lang.String imfPath)
Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:
tag - The AXL element tag containing this attribute.
name - The AXL attribute name.
value - The AXL attribute value.


Internet Mapping Framework for ArcIMS Java Object Model API (v5.0.004)
Copyright © 2005 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.