org.extex.unit.omega.ocp
Class Clearocplists

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.omega.ocp.Clearocplists

All Implemented Interfaces:

java.io.Serializable, Code

public class Clearocplists
extends AbstractAssignment

This class provides an implementation for the primitive \clearocplists.

The Primitive \clearocplists

The primitive \clearocplists disables the currently active ocplist. This operation respects grouping. It is an assignment.

Syntax

The formal description of this primitive is the following:

    ⟨clearocplists⟩
      → \clearocplists  

Examples

 \clearocplists 

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Constructor Summary

Clearocplists(CodeToken token)
Creates a new object.

Method Summary

void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().

Methods inherited from class org.extex.interpreter.type.AbstractAssignment

execute

Methods inherited from class org.extex.interpreter.type.AbstractCode

getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText

Methods inherited from class java.lang.Object

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

Constructor Detail

Clearocplists

public Clearocplists(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)