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
,org.pentaho.platform.api.engine.ILogger
,org.pentaho.platform.api.ui.IUIComponent
,org.pentaho.platform.api.ui.IXMLComponent
public class WidgetGridComponent extends XmlComponent
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent
contentTypes, debug, urlFactory, xslProperties
-
Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase
EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
-
-
Constructor Summary
Constructors Constructor Description WidgetGridComponent(String definitionPath, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
Creates a WidgetGrid
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
createDial(double value, String name, org.dom4j.Element root, WidgetDefinition widgetDefinition)
protected org.dom4j.Document
createDials(org.pentaho.commons.connection.IPentahoResultSet resultSet, WidgetDefinition widgetDefinition)
void
dispose()
protected org.pentaho.commons.connection.IPentahoResultSet
getActionData()
org.apache.commons.logging.Log
getLogger()
org.dom4j.Document
getXmlContent()
void
setColumns(int columns)
Sets the number of widgets that will be dispayed in a row before another row of widgets is createdboolean
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 widgetsvoid
setDrillUrlTemplate(String urlTemplate)
void
setInstanceId(String instanceId)
Sets the instance id for this executionvoid
setWidgetHeight(int widgetHeight)
Sets the height (in pixels) of the widget images that will be createdvoid
setWidgetWidth(int widgetWidth)
Sets the width (in pixels) of the widget images that will be createdboolean
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, getRequestHandler, getSession, getSourcePath, getUrlFactory, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setSourcePath, setUrlFactory, setXsl, setXslProperty, validate
-
Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger
debug, debug, error, 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
-
-
-
-
Constructor Detail
-
WidgetGridComponent
public WidgetGridComponent(String definitionPath, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
Creates a WidgetGridAfter creating an instance of this class
validate
should be called.- Parameters:
type
- The type of the widget, currently only TYPE_DIAL is supporteddefinitionPath
- The path and name of the XML definition of the dialwidgetWidth
- The width of the image to be createdwidgetHeight
- The height of the image to be createdurlFactory
- The urlFactory for the contentmessages
- The messages list for any logger messages
-
-
Method Detail
-
getLogger
public org.apache.commons.logging.Log getLogger()
- Specified by:
getLogger
in classBaseUIComponent
-
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 interfaceorg.pentaho.platform.api.ui.IUIComponent
- Specified by:
validate
in classBaseUIComponent
-
getXmlContent
public org.dom4j.Document getXmlContent()
- Specified by:
getXmlContent
in interfaceorg.pentaho.platform.api.ui.IXMLComponent
- Specified by:
getXmlContent
in classXmlComponent
-
createDials
protected org.dom4j.Document createDials(org.pentaho.commons.connection.IPentahoResultSet resultSet, WidgetDefinition widgetDefinition)
-
createDial
protected void createDial(double value, String name, org.dom4j.Element root, WidgetDefinition widgetDefinition)
-
dispose
public void dispose()
-
getActionData
protected org.pentaho.commons.connection.IPentahoResultSet getActionData()
-
-