Class actuate.xtabanalyzer.Sorter

Description

An object that represents a sort definition.

Constructor

Syntax

actuate.xtabanalyzer.Sorter(string levelName)

Constructs a new Sorter object.

Function summary

Table 5-17 lists actuate.xtabanalyzer.Sorter functions.

Table 5-17  actuate.xtabanalyzer.Sorter functions 

Function	Description
getKey( )	Returns the sort key.
getLevelName( )	Returns the level name.
getMember( )	Returns the sort member.
isAscending( )	Returns the sort direction.
setAscending( )	Sets ascending or descending sort.
setKey( )	Sets the sort key.
setLevelName( )	Sets the level name.
setMember( )	Sets the sort member.

actuate.xtabanalyzer.Sorter.getKey

Syntax  

string Sorter.getKey( )

Retrieves the sort key.

Returns

String. The sort key.

Example

This example retrieves the sort key.

function getSortKey(sorter){

  if (sorter){

    return sorter.getKey( );

  }

  return null;

}

actuate.xtabanalyzer.Sorter.getLevelName

Syntax  

string Sorter.getLevelName( )

Retrieves the sort key.

Returns

String. The level name.

Example

This example retrieves the level name associated with the sorter.

function getSortLevel(sorter){

  if (sorter){

    return sorter.getLevelName( );

  }

  return null;

}

actuate.xtabanalyzer.Sorter.getMember

Syntax  

string Sorter.getMember( )

Returns

The sort member.

Example

This example retrieves the sort member.

function getSortMember(sorter){

  if (sorter){

    return sorter.getMember( );

  }

  return null;

}

actuate.xtabanalyzer.Sorter.isAscending

Syntax  

boolean Sorter.isAscending( )

Returns

True when the sorter is ascending and false in all other cases.

Example

This example retrieves the level name that is associated with the sorter.

function ascending(sorter){

  if (sorter){

    return sorter.isAscending( );

  }

  return null;

}

actuate.xtabanalyzer.Sorter.setAscending

Syntax

void Sorter.setAscending(boolean ascending)

Sets the sorter to be ascending or descending.

Parameters

ascending

Boolean. Set to true for ascending, set to false for descending.

Example

This example swaps the sort direction.

sorter.setAscending(!(sorter.isAscending));

actuate.xtabanalyzer.Sorter.setKey

Syntax

void Sorter.setSortKey(string sortKey)

Sets the sort key.

Parameters

sortKey

String. The sort key.

Example

This example sets the sort key.

function setSortKey(sorter,key){

  sorter.setKey(key);

}

actuate.xtabanalyzer.Sorter.setLevelName

Syntax

void Sorter.setLevelName(string levelName)

Sets the level name to sort.

Parameters

levelName

String. The level name to sort.

Example

This example sets the level name to sort.

function setSortLevel(sorter,level){

  sorter.setLevelName(level);

}

actuate.xtabanalyzer.Sorter.setMember

Syntax

void Sorter.setMember(string member)

Sets the member.

Parameters

member

String. The member name.

Example

This example sets the sort member.

function setSortMember(sorter,member){

  sorter.setMember(member);

}

(c) Copyright Actuate Corporation 2011