org.pentaho.platform.uifoundation.component.xml
Class WidgetGridComponent

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.PentahoMessenger
          org.pentaho.platform.uifoundation.component.BaseUIComponent
              org.pentaho.platform.uifoundation.component.xml.XmlComponent
                  org.pentaho.platform.uifoundation.component.xml.WidgetGridComponent

All Implemented Interfaces:

Serializable, ILogger, IUIComponent, IXMLComponent

public class WidgetGridComponent
extends XmlComponent

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

debug

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

WidgetGridComponent(String definitionPath, IPentahoUrlFactory urlFactory, List messages)
Creates a WidgetGrid

Method Summary

void	dispose()
Log	getLogger()
Document	getXmlContent()
void	setColumns(int columns) Sets the number of widgets that will be dispayed in a row before another row of widgets is created
boolean	setDataAction(String widgetGridDataDefinition)
void	setDataAction(String solution, String actionPath, String actionName, String actionOutput, String nameItem, String valueItem) Sets the action to be executed to get the data for the widgets
void	setDrillUrlTemplate(String urlTemplate)
void	setInstanceId(String instanceId) Sets the instance id for this execution
void	setWidgetHeight(int widgetHeight) Sets the height (in pixels) of the widget images that will be created
void	setWidgetWidth(int widgetWidth) Sets the width (in pixels) of the widget images that will be created
boolean	validate()

Methods inherited from class org.pentaho.platform.uifoundation.component.xml.XmlComponent

getContent

Methods inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

done, getObjectParameter, getParameter, getParameterAsArray, getParameterProviders, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setUrlFactory, setXsl, setXslProperty, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetGridComponent

public WidgetGridComponent(String definitionPath,
                           IPentahoUrlFactory urlFactory,
                           List messages)

Creates a WidgetGrid

After creating an instance of this class validate should be called.

Parameters:

type - The type of the widget, currently only TYPE_DIAL is supported

definitionPath - The path and name of the XML definition of the dial

widgetWidth - The width of the image to be created

widgetHeight - The height of the image to be created

urlFactory - The urlFactory for the content

messages - The messages list for any logger messages

Method Detail

getLogger

public Log getLogger()

Specified by:

getLogger in class BaseUIComponent

setWidgetWidth

public void setWidgetWidth(int widgetWidth)

Sets the width (in pixels) of the widget images that will be created

Parameters:

widgetWidth -

setWidgetHeight

public void setWidgetHeight(int widgetHeight)

Sets the height (in pixels) of the widget images that will be created

Parameters:

widgetHeight -

setColumns

public void setColumns(int columns)

Sets the number of widgets that will be dispayed in a row before another row of widgets is created

Parameters:

instanceId -

setInstanceId

public void setInstanceId(String instanceId)

Sets the instance id for this execution

Parameters:

instanceId - The instance id of the parent object or process

setDataAction

public boolean setDataAction(String widgetGridDataDefinition)

setDataAction

public void setDataAction(String solution,
                          String actionPath,
                          String actionName,
                          String actionOutput,
                          String nameItem,
                          String valueItem)

Sets the action to be executed to get the data for the widgets

Parameters:

solution -

actionPath -

actionName -

actionOutput -

nameItem -

valueItem -

setDrillUrlTemplate

public void setDrillUrlTemplate(String urlTemplate)

validate

public boolean validate()

Specified by:

validate in interface IUIComponent

Specified by:

validate in class BaseUIComponent

getXmlContent

public Document getXmlContent()

Specified by:

getXmlContent in interface IXMLComponent

Specified by:

getXmlContent in class XmlComponent

dispose

public void dispose()