ilog.views.gantt.graphic.renderer

Class IlvGanttFunction.FormatDuration

java.lang.Object

ilog.views.util.styling.IlvCSSFunction

ilog.views.gantt.graphic.renderer.IlvGanttFunction.FormatDuration

All Implemented Interfaces:

Serializable

Enclosing class:

IlvGanttFunction

public static class IlvGanttFunction.FormatDuration
extends IlvCSSFunction

FormatDuration implements an expression that can be used in a style sheet to return a formatted duration String from an IlvDurationFormat representation and an IlvDuration.

Since:

JViews 8.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.util.styling.IlvCSSFunction

ANY, ANY_PROPERTIES, ANY_PSEUDOCLASSES

Constructor Summary

Constructors

Constructor and Description
FormatDuration() Builds a new FormatDuration CSS function.

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class type, ilog.views.util.css.IlvCSSModel model, Object node, Object target, Object closure) Calls the function.
String	getDelimiters() Returns the delimiters of the function parameters.
String	getName() Returns the name of the function that will be known in the style sheet.
String	getShortDescription() Returns a short description of the function.

Methods inherited from class ilog.views.util.styling.IlvCSSFunction

getDependencies, getImportance, returnDelimitersAsToken

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatDuration

public FormatDuration()

Builds a new FormatDuration CSS function.

Method Detail

getName

public String getName()

Returns the name of the function that will be known in the style sheet.

Specified by:

getName in class IlvCSSFunction

getDelimiters

public String getDelimiters()

Returns the delimiters of the function parameters. It is strongly recommended to return at least the comma (","). The default implementation returns ",".

Warning: css functions are processed inside an expression module which evaluates arithmetic operations before breaking the argument according to the delimiters. For example if "+" is a delimiter, the argument "3+1" will be evaluated to "4" instead of two arguments (3,1).

Overrides:

getDelimiters in class IlvCSSFunction

Returns:

A string containing all the accepted delimiters. A null or empty return value means there is no delimiter, so all the parameters are returned as a single token.

call

public Object call(Object[] args,
                   Class type,
                   ilog.views.util.css.IlvCSSModel model,
                   Object node,
                   Object target,
                   Object closure)

Calls the function.

Specified by:

call in class IlvCSSFunction

Parameters:

args - The parameters of the function.

type - The expected returned type, which may be null. It is wise to return an object compatible with the expected type, or a String.

model - The current model. Usually the model comes from the engine, but there are some situations where it is a new model.

node - The current node. This is the current model object being called on. Inside a @# construct, node represents the parent of the fake node indeed used to process the @# construct, i.e. the real node of interest.

target - The current rendered object being called on.

closure - An object set by IlvCSSBeans.setFunctionClosure(java.lang.Object)

Returns:

The value computed by this function.

getShortDescription

public String getShortDescription()

Returns a short description of the function. This description is used for instance in the expression editor of the customizers, to describe the function proposed to the user. The description should be localized to the locale returned by IlvLocaleUtil.getCurrentLocale().

Overrides:

getShortDescription in class IlvCSSFunction