Package org.pentaho.reporting.designer.core

Interface ReportDesignerContext

All Known Implementing Classes:

AbstractReportDesignerContext, DefaultReportDesignerContext

public interface ReportDesignerContext

A model that holds the current active render-context. A report-designer frame can have more than one render-context. It also has a welcome and a preview pane.

Author:

Thomas Morgner

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTIVE_CONTEXT_PROPERTY
static String	PAGE_PROPERTY
static String	PAGE_TOTAL_PROPERTY
static String	REPORT_RENDER_CONTEXT_PROPERTY
static String	SELECTION_WAITING_PROPERTY
static String	STATUS_TEXT_PROPERTY

Method Summary

Modifier and Type	Method	Description
int	addMasterReport(org.pentaho.reporting.engine.classic.core.MasterReport masterReportElement)
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String property, PropertyChangeListener listener)
int	addSubReport(ReportDocumentContext parentReportContext, org.pentaho.reporting.engine.classic.core.SubReport subReportElement)
int	findActiveContextIndex()
ReportDocumentContext	getActiveContext()
ReportDesignerDocumentContext<?>	getActiveDocument()
ReportDesignerDocumentContext	getDocumentContext(int index)
GlobalAuthenticationStore	getGlobalAuthenticationStore()
int	getPage()	Deprecated.
int	getPageTotal()	Deprecated.
Component	getParent()	Deprecated.
JPopupMenu	getPopupMenu(String id)	Deprecated.
RecentFilesModel	getRecentFilesModel()
ReportRenderContext	getReportRenderContext(int index)
int	getReportRenderContextCount()
JComponent	getToolBar(String id)	Deprecated.
ReportDesignerView	getView()
boolean	isSelectionWaiting()
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String property, PropertyChangeListener listener)
void	removeReportRenderContext(int index)
void	setActiveDocument(ReportDesignerDocumentContext<?> context)
void	setPageNumbers(int page, int pageTotal)	Deprecated.
void	setSelectionWaiting(boolean selectionWaiting)
void	setStatusText(String text)

Field Detail

REPORT_RENDER_CONTEXT_PROPERTY

static final String REPORT_RENDER_CONTEXT_PROPERTY

See Also:

Constant Field Values

ACTIVE_CONTEXT_PROPERTY

static final String ACTIVE_CONTEXT_PROPERTY

See Also:

Constant Field Values

STATUS_TEXT_PROPERTY

static final String STATUS_TEXT_PROPERTY

See Also:

Constant Field Values

SELECTION_WAITING_PROPERTY

static final String SELECTION_WAITING_PROPERTY

See Also:

Constant Field Values

PAGE_PROPERTY

static final String PAGE_PROPERTY

See Also:

Constant Field Values

PAGE_TOTAL_PROPERTY

static final String PAGE_TOTAL_PROPERTY

See Also:

Constant Field Values

Method Detail

getRecentFilesModel

RecentFilesModel getRecentFilesModel()

getActiveContext

ReportDocumentContext getActiveContext()

getActiveDocument

ReportDesignerDocumentContext<?> getActiveDocument()

setActiveDocument

void setActiveDocument(ReportDesignerDocumentContext<?> context)

setStatusText

void setStatusText(String text)

setPageNumbers

@Deprecated
void setPageNumbers(int page,
                    int pageTotal)

Deprecated.

getPage

@Deprecated
int getPage()

Deprecated.

getPageTotal

@Deprecated
int getPageTotal()

Deprecated.

getParent

@Deprecated
Component getParent()

Deprecated.

getPopupMenu

@Deprecated
JPopupMenu getPopupMenu(String id)

Deprecated.

getToolBar

@Deprecated
JComponent getToolBar(String id)

Deprecated.

addMasterReport

int addMasterReport(org.pentaho.reporting.engine.classic.core.MasterReport masterReportElement)
             throws org.pentaho.reporting.engine.classic.core.ReportDataFactoryException

Throws:

org.pentaho.reporting.engine.classic.core.ReportDataFactoryException

addSubReport

int addSubReport(ReportDocumentContext parentReportContext,
                 org.pentaho.reporting.engine.classic.core.SubReport subReportElement)
          throws org.pentaho.reporting.engine.classic.core.ReportDataFactoryException

Throws:

org.pentaho.reporting.engine.classic.core.ReportDataFactoryException

getDocumentContext

ReportDesignerDocumentContext getDocumentContext(int index)

getReportRenderContext

ReportRenderContext getReportRenderContext(int index)

getReportRenderContextCount

int getReportRenderContextCount()

removeReportRenderContext

void removeReportRenderContext(int index)

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(String property,
                               PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(String property,
                                  PropertyChangeListener listener)

getView

ReportDesignerView getView()

findActiveContextIndex

int findActiveContextIndex()

isSelectionWaiting

boolean isSelectionWaiting()

setSelectionWaiting

void setSelectionWaiting(boolean selectionWaiting)

getGlobalAuthenticationStore

GlobalAuthenticationStore getGlobalAuthenticationStore()