com.stimulsoft.report.components

Class StiInteraction

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.components.StiInteraction

All Implemented Interfaces:

IStiDefault, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiInteractionClass, IStiReportProperty, java.lang.Cloneable

Direct Known Subclasses:

StiBandInteraction, StiCrossHeaderInteraction

public class StiInteraction
extends StiSerializedObject
implements java.lang.Cloneable, IStiInteractionClass, IStiReportProperty, IStiDefault, IStiJsonReportObject

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	drillDownPageGuid
StiComponent	ParentComponent

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiInteraction()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
StiBookmarkExpression	getBookmark() Gets or sets the expression to fill a component bookmark.
boolean	getDrillDownEnabled() Gets or sets value which indicates whether the Drill-Down operation can be executed.
StiDrillDownMode	getDrillDownMode()
StiPage	getDrillDownPage() Gets or sets a page for the Drill-Down operation.
java.lang.String	getDrillDownPageGuid()
StiDrillDownParameter	getDrillDownParameter1() Gets or sets first Drill-Down parameter.
StiDrillDownParameter	getDrillDownParameter2() Gets or sets second Drill-Down parameter.
StiDrillDownParameter	getDrillDownParameter3() Gets or sets third Drill-Down parameter.
StiDrillDownParameter	getDrillDownParameter4() Gets or sets fourth Drill-Down parameter.
StiDrillDownParameter	getDrillDownParameter5() Gets or sets fifth Drill-Down parameter.
java.lang.String	getDrillDownReport() Gets or sets a path to a report for the Drill-Down operation.
StiHyperlinkExpression	getHyperlink() Gets or sets an expression to fill a component hyperlink.
StiReport	getReport() Gets or sets the report in which the component is located.
java.lang.Object	GetReport()
java.lang.String[]	GetSortColumns()
java.lang.String	GetSortColumnsString()
java.lang.String	GetSortDataBandName()
java.lang.String	getSortingColumn() Gets or sets a column by what data should be re-sorted in the report viewer.
StiInteractionSortDirection	getSortingDirection()
boolean	getSortingEnabled() Gets or sets value which indicates whether it is allowed or not, using given component, data re-sorting in the report viewer.
int	getSortingIndex()
StiTagExpression	getTag() Gets or sets the expression to fill a component tag.
StiToolTipExpression	getToolTip() Gets or sets the expression to fill a component tooltip.
boolean	isDefault()
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBookmark(StiBookmarkExpression value)
void	setDrillDownEnabled(boolean value)
void	setDrillDownMode(StiDrillDownMode drillDownMode)
void	setDrillDownPage(StiPage value)
void	setDrillDownPageGuid(java.lang.String value)
void	setDrillDownParameter1(StiDrillDownParameter value)
void	setDrillDownParameter2(StiDrillDownParameter value)
void	setDrillDownParameter3(StiDrillDownParameter value)
void	setDrillDownParameter4(StiDrillDownParameter value)
void	setDrillDownParameter5(StiDrillDownParameter value)
void	setDrillDownReport(java.lang.String value)
void	setHyperlink(StiHyperlinkExpression value)
void	setSortingColumn(java.lang.String value)
void	setSortingDirection(StiInteractionSortDirection value)
void	setSortingEnabled(boolean value)
void	setSortingIndex(int value)
void	setTag(StiTagExpression value)
void	setToolTip(StiToolTipExpression value)

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Field Detail

drillDownPageGuid

public java.lang.String drillDownPageGuid

ParentComponent

public StiComponent ParentComponent

Constructor Detail

StiInteraction

public StiInteraction()

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

isDefault

public boolean isDefault()

Specified by:

isDefault in interface IStiDefault

getDrillDownParameter1

public StiDrillDownParameter getDrillDownParameter1()

Gets or sets first Drill-Down parameter.

setDrillDownParameter1

public void setDrillDownParameter1(StiDrillDownParameter value)

getDrillDownParameter2

public StiDrillDownParameter getDrillDownParameter2()

Gets or sets second Drill-Down parameter.

setDrillDownParameter2

public void setDrillDownParameter2(StiDrillDownParameter value)

getDrillDownParameter3

public StiDrillDownParameter getDrillDownParameter3()

Gets or sets third Drill-Down parameter.

setDrillDownParameter3

public void setDrillDownParameter3(StiDrillDownParameter value)

getDrillDownParameter4

public StiDrillDownParameter getDrillDownParameter4()

Gets or sets fourth Drill-Down parameter.

setDrillDownParameter4

public void setDrillDownParameter4(StiDrillDownParameter value)

getDrillDownParameter5

public StiDrillDownParameter getDrillDownParameter5()

Gets or sets fifth Drill-Down parameter.

setDrillDownParameter5

public void setDrillDownParameter5(StiDrillDownParameter value)

getDrillDownPage

public StiPage getDrillDownPage()

Gets or sets a page for the Drill-Down operation.

setDrillDownPage

public void setDrillDownPage(StiPage value)

getHyperlink

public StiHyperlinkExpression getHyperlink()

Gets or sets an expression to fill a component hyperlink.

setHyperlink

public void setHyperlink(StiHyperlinkExpression value)

getTag

public StiTagExpression getTag()

Gets or sets the expression to fill a component tag.

setTag

public void setTag(StiTagExpression value)

getToolTip

public StiToolTipExpression getToolTip()

Gets or sets the expression to fill a component tooltip.

setToolTip

public void setToolTip(StiToolTipExpression value)

GetSortDataBandName

public final java.lang.String GetSortDataBandName()

GetSortColumns

public final java.lang.String[] GetSortColumns()

GetSortColumnsString

public final java.lang.String GetSortColumnsString()

GetReport

public final java.lang.Object GetReport()

clone

public final java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getSortingEnabled

public boolean getSortingEnabled()

Gets or sets value which indicates whether it is allowed or not, using given component, data re-sorting in the report viewer.

setSortingEnabled

public void setSortingEnabled(boolean value)

getSortingColumn

public java.lang.String getSortingColumn()

Gets or sets a column by what data should be re-sorted in the report viewer.

setSortingColumn

public void setSortingColumn(java.lang.String value)

getSortingIndex

public int getSortingIndex()

setSortingIndex

public void setSortingIndex(int value)

getSortingDirection

public StiInteractionSortDirection getSortingDirection()

setSortingDirection

public void setSortingDirection(StiInteractionSortDirection value)

getDrillDownEnabled

public boolean getDrillDownEnabled()

Gets or sets value which indicates whether the Drill-Down operation can be executed.

setDrillDownEnabled

public void setDrillDownEnabled(boolean value)

getDrillDownReport

public java.lang.String getDrillDownReport()

Gets or sets a path to a report for the Drill-Down operation.

setDrillDownReport

public void setDrillDownReport(java.lang.String value)

getDrillDownPageGuid

public final java.lang.String getDrillDownPageGuid()

setDrillDownPageGuid

public final void setDrillDownPageGuid(java.lang.String value)

getBookmark

public StiBookmarkExpression getBookmark()

Gets or sets the expression to fill a component bookmark.

setBookmark

public void setBookmark(StiBookmarkExpression value)

getReport

public StiReport getReport()

Description copied from interface: IStiReportProperty

Gets or sets the report in which the component is located.

Specified by:

getReport in interface IStiReportProperty

getDrillDownMode

public StiDrillDownMode getDrillDownMode()

Returns:

the drillDownMode

setDrillDownMode

public void setDrillDownMode(StiDrillDownMode drillDownMode)

Parameters:

drillDownMode - the drillDownMode to set