public class DashboardWidgetComponent extends XmlComponent
Modifier and Type | Field and Description |
---|---|
static int |
TYPE_DIAL |
static int |
TYPE_THERMOMETER |
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 |
---|
DashboardWidgetComponent(int type,
String definitionPath,
int width,
int height,
IPentahoUrlFactory urlFactory,
List messages)
Creates a DashboardWidgetComponent.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose() |
org.apache.commons.logging.Log |
getLogger()
Gets the logger for his component.
|
org.dom4j.Document |
getXmlContent()
Create a dial image.
|
void |
setTitle(String title)
Sets the title for the dial
|
void |
setUnits(String units)
Sets the unit for the dial value
|
void |
setValue(double value)
Sets the value to be displayed by the dial.
|
boolean |
validate()
Validate that this component can generate the requested dial
|
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 static final int TYPE_DIAL
public static final int TYPE_THERMOMETER
public DashboardWidgetComponent(int type, String definitionPath, int width, int height, 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 dialwidth
- The width of the image to be createdheight
- The height of the image to be createdurlFactory
- The urlFactory for the contentmessages
- The messages list for any logger messagespublic void setValue(double value)
value
- The dial valuepublic void setTitle(String title)
title
- The title of the dialpublic void setUnits(String units)
units
- The dial unitspublic org.apache.commons.logging.Log getLogger()
getLogger
in class BaseUIComponent
public boolean validate()
validate
in interface IUIComponent
validate
in class BaseUIComponent
public org.dom4j.Document getXmlContent()
getXmlContent
in interface IXMLComponent
getXmlContent
in class XmlComponent
public void dispose()
Copyright © 2017 Hitachi Vantara. All rights reserved.