org.fit.layout.cssbox

Class CSSBoxTreeProvider

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseBoxTreeProvider

org.fit.layout.cssbox.CSSBoxTreeProvider

All Implemented Interfaces:

BoxTreeProvider, ParametrizedOperation, Service

public class CSSBoxTreeProvider
extends BaseBoxTreeProvider

A box tree provider implementation based on CSSBox

Author:

burgetr

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.api.ParametrizedOperation

ParametrizedOperation.ValueType

Constructor Summary

Constructors

Constructor and Description
CSSBoxTreeProvider()
CSSBoxTreeProvider(java.net.URL url, int width, int height)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() Obtains a longer description of the service.
int	getHeight()
java.lang.String	getId() Obtains a unique ID of the service
java.lang.String	getName() Obtains a descriptive name of the service that may be presented to the user.
Page	getPage() Renders the page and returns the page model.
java.lang.String[]	getParamNames() Obtains a list of available parameter names of the operation.
java.lang.Object[]	getParamRange(java.lang.String name) Obtains the minimal and maximal value of the given parameter.
ParametrizedOperation.ValueType[]	getParamTypes() Obtains a list of available parameter value types.
java.net.URL	getUrl()
int	getWidth()
void	setHeight(int height)
void	setUrl(java.lang.String url)
void	setUrl(java.net.URL url)
void	setWidth(int width)

Methods inherited from class org.fit.layout.impl.BaseBoxTreeProvider

toString

Methods inherited from class org.fit.layout.impl.BaseParametrizedOperation

getParam, setParam

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, setParam

Constructor Detail

CSSBoxTreeProvider

public CSSBoxTreeProvider()

CSSBoxTreeProvider

public CSSBoxTreeProvider(java.net.URL url,
                  int width,
                  int height)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Service

Obtains a unique ID of the service

getName

public java.lang.String getName()

Description copied from interface: Service

Obtains a descriptive name of the service that may be presented to the user.

Returns:

the operator name

getDescription

public java.lang.String getDescription()

Description copied from interface: Service

Obtains a longer description of the service.

Returns:

the description

getParamNames

public java.lang.String[] getParamNames()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter names of the operation.

Returns:

an array of parameter names

getParamTypes

public ParametrizedOperation.ValueType[] getParamTypes()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter value types.

Returns:

an array of value types

getUrl

public java.net.URL getUrl()

setUrl

public void setUrl(java.net.URL url)

setUrl

public void setUrl(java.lang.String url)

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

getParamRange

public java.lang.Object[] getParamRange(java.lang.String name)

Description copied from interface: ParametrizedOperation

Obtains the minimal and maximal value of the given parameter.

Specified by:

getParamRange in interface ParametrizedOperation

Overrides:

getParamRange in class BaseParametrizedOperation

Parameters:

name - the name of the parameter

Returns:

Array of two objects [min, max] for numeric types, [min_length, max_length] for string types, null for other types or non-existing parameters

getPage

public Page getPage()

Description copied from interface: BoxTreeProvider

Renders the page and returns the page model.

Returns:

The resulting page model or null when an error occured.