com.ge.research.acuity.web.struts.form
Class NewHighlightRegionForm

java.lang.Object
  org.apache.struts.action.ActionForm
      com.ge.research.acuity.web.struts.form.NewHighlightRegionForm

All Implemented Interfaces:

java.io.Serializable

public final class NewHighlightRegionForm

extends org.apache.struts.action.ActionForm

Represents the information necessary to create a new independent highlight region, or share an existing highlight region.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:48 $

Author:

garbiras

See Also:

Serialized Form

Created on:

Jun 28, 2005

Field Summary

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

NewHighlightRegionForm()

Method Summary

int	getAlpha() Returns the opaqueness component of the highlight region Color The component value is in the range 0-255
java.lang.String	getAnchorChoiceLabel() Returns the label to be used for the anchor choice input object of the form.
java.util.List	getAnchorChoices() Returns the set of possible appliesTo values for the highlight region.
java.lang.String	getAppliesTo() Returns the appliesTo reference for the highlight region.
int	getBlueVal() Returns the RGB blue value component of the highlight region Color The component value is in the range 0-255
int	getGreenVal() Returns the RGB green value component of the highlight region Color The component value is in the range 0-255
java.lang.String	getHiThreshold() Gets the upper threshold value for the highlight region.
java.lang.String	getHlrAction() Returns the action associated with the supplied information of the form, identifying that the information is to be used to create a new independent highlight region, or used to identify and share an existing highlight region.
java.util.Map	getHlrChoices() Returns the set of existing highlight regions, mapped to their region properties.
java.lang.String	getLoThreshold() Gets the lower threshold value for the highlight region.
java.lang.String	getMember() Returns the identifier of the PresentationObject for which the highlight region is being created.
int	getRedVal() Returns the RGB red value component of the highlight region Color The component value is in the range 0-255
java.lang.String	getSharedHLR() Returns the existing highlight region, if any, that the PresentationObject should share
boolean	isForGraph() Returns the value of the Flag indicating whether or not the highlight region is for a GraphPO
void	setAlpha(int alpha) Sets the opaqueness component of the highlight region Color from the client interface.
void	setAnchorChoices(java.util.List anchorChoices) Sets the possible appliesTo values for the highlight region.
void	setAppliesTo(java.lang.String appliesTo) Sets the appliesTo reference for the highlight region from the client interface.
void	setBlueVal(int blueVal) Sets the RGB blue component of the highlight region Color from the client interface.
void	setGreenVal(int greenVal) Sets the RGB green component of the highlight region Color from the client interface.
void	setHiThreshold(java.lang.String hiThreshold) Sets the upper threshold value for the highlight region from the client interface.
void	setHlrAction(java.lang.String hlrAction) Sets the action associated with the supplied information of the form, identifying that the information is to be used to create a new independent highlight region, or used to identify and share an existing highlight region.
void	setHlrChoices(java.util.Map hlrChoices) Sets the set of existing highlight regions, mapped to their region properties.
void	setLoThreshold(java.lang.String loThreshold) Sets the lower threshold value for the highlight region from the client interface.
void	setMember(java.lang.String member) Sets the identifier of the PresentationObject for which the highlight region is being created.
void	setMemberType(java.lang.Class memberType) Using the type of PresentationObject the highlight region is to be created for, sets the value of the graphHLR flag and the value of the anchorChoiceLabel attribute.
void	setRedVal(int redVal) Sets the RGB red component of the highlight region Color from the client interface.
void	setSharedHLR(java.lang.String sharedHLR) Sets the existing highlight region that the PresentationObject should share

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NewHighlightRegionForm

public NewHighlightRegionForm()

Method Detail

getAlpha

public int getAlpha()

Returns the opaqueness component of the highlight region Color The component value is in the range 0-255

Returns:

The opaqueness component of the highlight region color

getAnchorChoiceLabel

public java.lang.String getAnchorChoiceLabel()

Returns the label to be used for the anchor choice input object of the form. Corresponds to the type of PresentationObject the highlight region is for. The label will be one of the following: APPLIES_TO_GRAPH, APPLIES_TO_TABLE, APPLIES_TO_UNKNOWN

Returns:

The label to use for the appliesTo form element

getAnchorChoices

public java.util.List getAnchorChoices()

Returns the set of possible appliesTo values for the highlight region. If the highlight region is for a table, the choices will be the columns of that table. If the highlight region is for a graph, the choices will be the axes of that graph. Each element of the list is a Map with the key being a valid value for the appliesTo property, and the value being a display string for that choice. The list preserves any ordering of the choices, that we wish to retain.

Returns:

The valid choices for the appliesTo attribute of the highlight region, for the type of PresentationObject the highlight region is for

getAppliesTo

public java.lang.String getAppliesTo()

Returns the appliesTo reference for the highlight region. It is either the x or y axis, or table column number.

Returns:

The value of the appliesTo reference for the highlight region

getBlueVal

public int getBlueVal()

Returns the RGB blue value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB blue value component of the highlight region color

getGreenVal

public int getGreenVal()

Returns the RGB green value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB green value component of the highlight region color

getHiThreshold

public java.lang.String getHiThreshold()

Gets the upper threshold value for the highlight region.

Returns:

The upper threshold value for the highlight region

getHlrAction

public java.lang.String getHlrAction()

Returns the action associated with the supplied information of the form, identifying that the information is to be used to create a new independent highlight region, or used to identify and share an existing highlight region.

Returns:

The action keyword distinguishing a create request from a share request.

See Also:

AcuityConstants.CREATE_HLR, AcuityConstants.SHARE_HLR

getHlrChoices

public java.util.Map getHlrChoices()

Returns the set of existing highlight regions, mapped to their region properties.

Returns:

The set of existing highlight regions, mapped to their region properties.

getLoThreshold

public java.lang.String getLoThreshold()

Gets the lower threshold value for the highlight region.

Returns:

The lower threshold value for the highlight region

getMember

public java.lang.String getMember()

Returns the identifier of the PresentationObject for which the highlight region is being created.

Returns:

The identifier of the PresentationObject for which the highlight region is being created.

getRedVal

public int getRedVal()

Returns the RGB red value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB red value component of the highlight region color

getSharedHLR

public java.lang.String getSharedHLR()

Returns the existing highlight region, if any, that the PresentationObject should share

Returns:

The existing highlight region, if any, that the PresentationObject should share

isForGraph

public boolean isForGraph()

Returns the value of the Flag indicating whether or not the highlight region is for a GraphPO

Returns:

true if the highlight region is for a GraphPO; false otherwise

setAlpha

public void setAlpha(int alpha)

Sets the opaqueness component of the highlight region Color from the client interface.

Parameters:

alpha - the opaqueness component of the highlight region color

setAnchorChoices

public void setAnchorChoices(java.util.List anchorChoices)

Sets the possible appliesTo values for the highlight region. If the highlight region is for a table, the choices should be the columns of that table. If the highlight region is for a graph, the choices should be the axes of that graph. Each element of the list should be a Map with the key being a valid value for the appliesTo property, and the value being a display string for that choice. The list preserves any ordering of the choices, that we wish to retain.

Returns:

The valid choices for the appliesTo attribute of the highlight region, for the type of PresentationObject the highlight region is for

setAppliesTo

public void setAppliesTo(java.lang.String appliesTo)

Sets the appliesTo reference for the highlight region from the client interface. Associates the highlight region with either the x or y axis, or table column number.

Parameters:

appliesTo - the value of the appliesTo reference for the highlight region

setBlueVal

public void setBlueVal(int blueVal)

Sets the RGB blue component of the highlight region Color from the client interface.

Parameters:

blueVal - the RGB blue component of the highlight region color

setGreenVal

public void setGreenVal(int greenVal)

Sets the RGB green component of the highlight region Color from the client interface.

Parameters:

greenVal - the RGB green component of the highlight region color

setHiThreshold

public void setHiThreshold(java.lang.String hiThreshold)

Sets the upper threshold value for the highlight region from the client interface.

Parameters:

hiThreshold - the upper threshold value for the highlight region

setHlrAction

public void setHlrAction(java.lang.String hlrAction)

Sets the action associated with the supplied information of the form, identifying that the information is to be used to create a new independent highlight region, or used to identify and share an existing highlight region.

Parameters:

hlrAction - the action keyword distinguishing a create request from a share request.

See Also:

AcuityConstants.CREATE_HLR, AcuityConstants.SHARE_HLR

setHlrChoices

public void setHlrChoices(java.util.Map hlrChoices)

Sets the set of existing highlight regions, mapped to their region properties.

Parameters:

hlrChoices - the set of existing highlight regions, mapped to their region properties.

setLoThreshold

public void setLoThreshold(java.lang.String loThreshold)

Sets the lower threshold value for the highlight region from the client interface.

Parameters:

loThreshold - the lower threshold value for the highlight region

setMember

public void setMember(java.lang.String member)

Sets the identifier of the PresentationObject for which the highlight region is being created.

Parameters:

member - the identifier of the PresentationObject for which the highlight region is being created.

setMemberType

public void setMemberType(java.lang.Class memberType)

Using the type of PresentationObject the highlight region is to be created for, sets the value of the graphHLR flag and the value of the anchorChoiceLabel attribute.

Parameters:

memberType - the type of PresentationObject the highlight region is to be created for

setRedVal

public void setRedVal(int redVal)

Sets the RGB red component of the highlight region Color from the client interface.

Parameters:

redVal - the RGB red component of the highlight region color

setSharedHLR

public void setSharedHLR(java.lang.String sharedHLR)

Sets the existing highlight region that the PresentationObject should share

Parameters:

sharedHLR - the existing highlight region that the PresentationObject should share; null if an independent highlight region should be created.