Package com.microstrategy.web.app.beans

Class DerivedElementsBrowserBeanImpl

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.AbstractObjectExplorerBean

com.microstrategy.web.app.beans.DerivedElementsBrowserBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, DerivedElementsBrowserBean, ObjectExplorerBean, RequestPersistable, Transformable, WebComponent

public class DerivedElementsBrowserBeanImpl
extends AbstractObjectExplorerBean
implements DerivedElementsBrowserBean

Since:

MicroStrategy Web 9.0.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
DerivedElementsBrowserBeanImpl()

Method Summary

Modifier and Type	Method	Description
java.util.ArrayList	getAncestors()
java.util.ArrayList	getContents()
java.util.ArrayList	getContents(boolean sortAscending)
WebDisplayUnit	getCurrentUnit()
WebDerivedElements	getDerivedElements()
java.util.ArrayList	getLinks()
int	getObjectCount()
java.lang.String	getSearchName()
int	getTotalObjectCount()
boolean	isEditable()
boolean	isEditor()	Indicates whether a ReportFrameElement most be considered editor.
boolean	isEnabled()
int	move(java.lang.String deId, int offset)
protected WebEventHandler	newDefaultEventHandler()
void	setChanged(boolean value)	Sets the changed state of the component
boolean	shallEditName()	Indicates that client shall immediately open name editor for the current element

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

getBlockBegin, getBlockCount, getErrorMessage, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

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, doFlatState, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

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

addChildStateInfo, collectData, 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, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, 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.ObjectExplorerBean

getBlockBegin, getBlockCount, getErrorMessage, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

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

restoreState, restoreState

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

restoreStateFromRequest, restoreStateFromRequest

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.beans.WebComponent

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

Constructor Detail

DerivedElementsBrowserBeanImpl

public DerivedElementsBrowserBeanImpl()

Method Detail

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

move

public int move(java.lang.String deId,
                int offset)

Specified by:

move in interface DerivedElementsBrowserBean

getContents

public java.util.ArrayList getContents()

Specified by:

getContents in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

getContents

public java.util.ArrayList getContents(boolean sortAscending)

Specified by:

getContents in interface ObjectExplorerBean

Parameters:

sortAscending - specifies if the results should be sorted ascending or descending.

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

getTotalObjectCount

public int getTotalObjectCount()

Specified by:

getTotalObjectCount in interface ObjectExplorerBean

Returns:

the total number of objects contained in the current object

getObjectCount

public int getObjectCount()

Specified by:

getObjectCount in interface ObjectExplorerBean

Returns:

the number of objects contained in the object's current block.

getCurrentUnit

public WebDisplayUnit getCurrentUnit()

Specified by:

getCurrentUnit in interface ObjectExplorerBean

Returns:

a WebDisplayUnit that represents the current object

isEnabled

public boolean isEnabled()

isEditor

public boolean isEditor()

Description copied from class: AbstractPersistableFrameElement

Indicates whether a ReportFrameElement most be considered editor. Editors are treated specially by the ReportFrame: only one editor can be shown at any time.

Overrides:

isEditor in class AbstractPersistableFrameElement

Returns:

false, editors needs to override this method.

getAncestors

public java.util.ArrayList getAncestors()

Specified by:

getAncestors in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders)

getLinks

public java.util.ArrayList getLinks()

Specified by:

getLinks in interface ObjectExplorerBean

Returns:

an List of WebDisplayUnit objects that represent the project links.

getSearchName

public java.lang.String getSearchName()

Specified by:

getSearchName in interface ObjectExplorerBean

Returns:

The current search name if any.

isEditable

public boolean isEditable()

Specified by:

isEditable in interface DerivedElementsBrowserBean

setChanged

public void setChanged(boolean value)

Description copied from class: AbstractWebComponent

Sets the changed state of the component

Specified by:

setChanged in interface WebComponent

Overrides:

setChanged in class AbstractWebComponent

Parameters:

value - a boolean value indicating whether the component is changed.

getDerivedElements

public WebDerivedElements getDerivedElements()

Specified by:

getDerivedElements in interface DerivedElementsBrowserBean

shallEditName

public boolean shallEditName()

Description copied from interface: DerivedElementsBrowserBean

Indicates that client shall immediately open name editor for the current element

Specified by:

shallEditName in interface DerivedElementsBrowserBean