Package org.pentaho.platform.uifoundation.component.xml

Class FilterPanelComponent

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.FilterPanelComponent

All Implemented Interfaces:

Serializable, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.ui.IUIComponent, org.pentaho.platform.api.ui.IXMLComponent

public class FilterPanelComponent
extends XmlComponent

This class provides a user interface that lets users select items from lists or radio buttons. The selections are used by other components to filter queries used to populate data.

Author:

James Dixon

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

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

Constructors

Constructor	Description
FilterPanelComponent(String definitionPath, String xslName, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)

Method Summary

Modifier and Type	Method	Description
List	getFilters()
org.apache.commons.logging.Log	getLogger()
org.dom4j.Document	getXmlContent()
boolean	init()
void	setDefaultValue(String filterName, String[] defaultValue)
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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterPanelComponent

public FilterPanelComponent(String definitionPath,
                            String xslName,
                            org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory,
                            List messages)

Method Detail

setDefaultValue

public void setDefaultValue(String filterName,
                            String[] defaultValue)

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class BaseUIComponent

validate

public boolean validate()

Specified by:

validate in interface org.pentaho.platform.api.ui.IUIComponent

Specified by:

validate in class BaseUIComponent

getFilters

public List getFilters()

init

public boolean init()

getXmlContent

public org.dom4j.Document getXmlContent()

Specified by:

getXmlContent in interface org.pentaho.platform.api.ui.IXMLComponent

Specified by:

getXmlContent in class XmlComponent