public class WidgetGridComponent extends XmlComponent
contentTypes, debug, urlFactory, xslProperties
EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN
Constructor and Description |
---|
WidgetGridComponent(String definitionPath,
IPentahoUrlFactory urlFactory,
List messages)
Creates a WidgetGrid
|
Modifier and Type | Method and 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 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() |
getContent
done, getObjectParameter, getParameter, getParameterAsArray, getParameterProviders, getRequestHandler, getSession, getSourcePath, getUrlFactory, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setSourcePath, setUrlFactory, setXsl, setXslProperty, validate
debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn
genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, setLoggingLevel, setLogId
public WidgetGridComponent(String definitionPath, IPentahoUrlFactory urlFactory, List messages)
After creating an instance of this class validate
should be called.
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 messagespublic org.apache.commons.logging.Log getLogger()
getLogger
in class BaseUIComponent
public void setWidgetWidth(int widgetWidth)
widgetWidth
- public void setWidgetHeight(int widgetHeight)
widgetHeight
- public void setColumns(int columns)
instanceId
- public void setInstanceId(String instanceId)
instanceId
- The instance id of the parent object or processpublic boolean setDataAction(String widgetGridDataDefinition)
public void setDataAction(String solution, String actionPath, String actionName, String actionOutput, String nameItem, String valueItem)
solution
- actionPath
- actionName
- actionOutput
- nameItem
- valueItem
- public void setDrillUrlTemplate(String urlTemplate)
public boolean validate()
validate
in interface IUIComponent
validate
in class BaseUIComponent
public org.dom4j.Document getXmlContent()
getXmlContent
in interface IXMLComponent
getXmlContent
in class XmlComponent
protected org.dom4j.Document createDials(org.pentaho.commons.connection.IPentahoResultSet resultSet, WidgetDefinition widgetDefinition)
protected void createDial(double value, String name, org.dom4j.Element root, WidgetDefinition widgetDefinition)
public void dispose()
protected org.pentaho.commons.connection.IPentahoResultSet getActionData()
Copyright © 2017 Hitachi Vantara. All rights reserved.