Package com.microstrategy.web.app.beans

Class GridColorGradientEditorBeanImpl

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.beans.AbstractTransformable

com.microstrategy.web.beans.AbstractWebComponent

com.microstrategy.web.app.beans.AbstractAppComponent

com.microstrategy.web.app.beans.AbstractPersistableAppComponent

com.microstrategy.web.app.beans.AbstractPersistableFrameElement

com.microstrategy.web.app.beans.AbstractViewBeanParserBean

com.microstrategy.web.app.beans.AbstractColorGradientEditorBeanImpl

com.microstrategy.web.app.beans.RWDColorGradientEditorBeanImpl

com.microstrategy.web.app.beans.GridColorGradientEditorBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, ColorGradientEditorBean, FrameElement, GridColorGradientEditorBean, ReportFrameElement, RWDColorGradientEditorBean, ViewBeanParserBean, RequestPersistable, Transformable, WebComponent

public class GridColorGradientEditorBeanImpl
extends RWDColorGradientEditorBeanImpl
implements GridColorGradientEditorBean

Since:

MicroStrategy Web 8.1.0

Field Summary

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Constructor Summary

Constructors

Constructor	Description
GridColorGradientEditorBeanImpl()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	collectData()	Triggers execution to the back end no matter whether it is synchronous or asynchronous.
int	getAngle()	Get the angle of the gradient
java.lang.String	getColor1()
java.lang.String	getColor2()
int	getTargetAxis()	Get the axis where the target is located
int	getTargetLevel()	Get the level at which the formatting will be applied
int	getTargetPosition()	Get the position in the axis where the target is located
int	getXOffset()
int	getYOffset()
void	setTargetAxis(int axis)	Set the axis where the target is located
void	setTargetLevel(int level)	Set the level at which the formatting will be applied
void	setTargetPosition(int position)	Set the position in the axis where the target is located

Methods inherited from class com.microstrategy.web.app.beans.RWDColorGradientEditorBeanImpl

getAllPanels, getFormatType, getRetrieveGradient, getStartFromSolid, setAllPanels, setFormatType, setRetrieveGradient, setStartFromSolid

Methods inherited from class com.microstrategy.web.app.beans.AbstractColorGradientEditorBeanImpl

doFlatState, getControlID, getCurrentPreview, getParentBoneID, getShadingStyle, getTransitionType, isEditor, isEnabled, setAngle, setColor1, setColor2, setControlID, setCurrentPreview, setParentBoneID, setShadingStyle, setTransitionType, setXOffset, setYOffset

Methods inherited from class com.microstrategy.web.app.beans.AbstractViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isGridDataNecessary, isIFrameEnabled, isOpen, setIsOpen, setUseIFrame

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, newDefaultEventHandler, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.ColorGradientEditorBean

getControlID, getCurrentPreview, getParentBoneID, getShadingStyle, getTransitionType, setAngle, setColor1, setColor2, setControlID, setCurrentPreview, setParentBoneID, setShadingStyle, setTransitionType, setXOffset, setYOffset

Methods inherited from interface com.microstrategy.web.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.app.beans.RWDColorGradientEditorBean

getAllPanels, getFormatType, getRetrieveGradient, getStartFromSolid, setAllPanels, setFormatType, setRetrieveGradient, setStartFromSolid

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler

Constructor Detail

GridColorGradientEditorBeanImpl

public GridColorGradientEditorBeanImpl()

Default constructor

Method Detail

collectData

public void collectData()
                 throws WebBeanException

Description copied from class: AbstractAppComponent

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. If AbstractAppComponent.isOpen(), this method will first perform a AbstractAppComponent.doCollectData(), then proceeds to call AbstractAppComponent.collectData() on all child components AbstractWebComponent.getChild(int).

Specified by:

collectData in interface WebComponent

Overrides:

collectData in class AbstractAppComponent

Throws:

WebBeanException - thrown if there is any exception

getTargetAxis

public int getTargetAxis()

Description copied from interface: GridColorGradientEditorBean

Get the axis where the target is located

Specified by:

getTargetAxis in interface GridColorGradientEditorBean

Returns:

Element from the EnumDSSXMLAxisName enumeration

See Also:

FormatTabBean.getTargetAxis()

setTargetAxis

public void setTargetAxis(int axis)

Description copied from interface: GridColorGradientEditorBean

Set the axis where the target is located

Specified by:

setTargetAxis in interface GridColorGradientEditorBean

Parameters:

axis - Element from the EnumDSSXMLAxisName enumeration

See Also:

FormatTabBean.setTargetAxis(int)

getTargetPosition

public int getTargetPosition()

Get the position in the axis where the target is located

Specified by:

getTargetPosition in interface GridColorGradientEditorBean

Returns:

the index where the target is located

setTargetPosition

public void setTargetPosition(int position)

Set the position in the axis where the target is located

Specified by:

setTargetPosition in interface GridColorGradientEditorBean

Parameters:

position - the index where the target is located

getTargetLevel

public int getTargetLevel()

Get the level at which the formatting will be applied

Specified by:

getTargetLevel in interface GridColorGradientEditorBean

Returns:

Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

setTargetLevel

public void setTargetLevel(int level)

Set the level at which the formatting will be applied

Specified by:

setTargetLevel in interface GridColorGradientEditorBean

Parameters:

level - Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

getColor1

public java.lang.String getColor1()

Specified by:

getColor1 in interface ColorGradientEditorBean

Overrides:

getColor1 in class AbstractColorGradientEditorBeanImpl

Returns:

the first color of the gradient

getColor2

public java.lang.String getColor2()

Specified by:

getColor2 in interface ColorGradientEditorBean

Overrides:

getColor2 in class AbstractColorGradientEditorBeanImpl

Returns:

the second color of the gradient

getAngle

public int getAngle()

Description copied from interface: ColorGradientEditorBean

Get the angle of the gradient

Specified by:

getAngle in interface ColorGradientEditorBean

Overrides:

getAngle in class AbstractColorGradientEditorBeanImpl

Returns:

angle of the gradient

getXOffset

public int getXOffset()

Specified by:

getXOffset in interface ColorGradientEditorBean

Overrides:

getXOffset in class AbstractColorGradientEditorBeanImpl

Returns:

the x-offset of the gradient

getYOffset

public int getYOffset()

Specified by:

getYOffset in interface ColorGradientEditorBean

Overrides:

getYOffset in class AbstractColorGradientEditorBeanImpl

Returns:

the Y-offset of the gradient