uk.co.prosperosoftware.pspnum
Class PSPDecMask

java.lang.Object
  |
  +--uk.co.prosperosoftware.pspnum.PSPDecMask

public class PSPDecMask

extends java.lang.Object

PSPDecMask (short for 'Prospero Software Products Decimal Mask') controls formatting of decimal values and allowable keystrokes for editing decimal values. Click here for a full description of how this mask is used by PSPDec and PSPNum objects, and how you set/get/use mask properties.

Version:

4.4 05Jun2003

Author:

www.prosperosoftware.co.uk

Field Summary

static int

PSPDECMASK_COMPONENT_SIZE Maximum size each mask component (30 characters).

Constructor Summary

PSPDecMask()
Default (only) constructor which sets initial edit mask of [NB-][3S,][DP.][DI.][DV.] and all other mask components to null (no value).

Method Summary

java.lang.String	get3S() Returns '3S' component of mask
java.lang.String	get4S() Returns '4S' component of mask
java.lang.String	getDI() Returns 'DI' component of mask
java.lang.String	getDP() Returns 'DP' component of mask
java.lang.String	getDV() Returns 'DV' component of mask
java.lang.String	getMask() Returns all components of edit mask.
java.lang.String	getMaskUsed() Returns used components of edit mask.
java.lang.String	getNA() Returns 'NA' component of mask
java.lang.String	getNB() Returns 'NB' component of mask
java.lang.String	getOA() Returns 'OA' component of mask
java.lang.String	getOB() Returns 'OB' component of mask
java.lang.String	getPA() Returns 'PA' component of mask
java.lang.String	getPB() Returns 'PB' component of mask
java.lang.String	getZA() Returns 'ZA' component of mask
java.lang.String	getZB() Returns 'ZB' component of mask
java.lang.String	getZL() Returns 'ZL' component of mask
void	set(java.lang.String mask) Set one or more mask components.

Methods inherited from class java.lang.Object

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

Field Detail

PSPDECMASK_COMPONENT_SIZE

public static final int PSPDECMASK_COMPONENT_SIZE

Maximum size each mask component (30 characters).

See Also:

Constant Field Values

Constructor Detail

PSPDecMask

public PSPDecMask()

Default (only) constructor which sets initial edit mask of [NB-][3S,][DP.][DI.][DV.] and all other mask components to null (no value).

Method Detail

getOB

public java.lang.String getOB()

Returns 'OB' component of mask

getNB

public java.lang.String getNB()

Returns 'NB' component of mask

getPB

public java.lang.String getPB()

Returns 'PB' component of mask

getZB

public java.lang.String getZB()

Returns 'ZB' component of mask

getZL

public java.lang.String getZL()

Returns 'ZL' component of mask

get4S

public java.lang.String get4S()

Returns '4S' component of mask

get3S

public java.lang.String get3S()

Returns '3S' component of mask

getDP

public java.lang.String getDP()

Returns 'DP' component of mask

getDI

public java.lang.String getDI()

Returns 'DI' component of mask

getDV

public java.lang.String getDV()

Returns 'DV' component of mask

getNA

public java.lang.String getNA()

Returns 'NA' component of mask

getPA

public java.lang.String getPA()

Returns 'PA' component of mask

getZA

public java.lang.String getZA()

Returns 'ZA' component of mask

getOA

public java.lang.String getOA()

Returns 'OA' component of mask

set

public void set(java.lang.String mask)

Set one or more mask components.

getMask

public final java.lang.String getMask()

Returns all components of edit mask.

Returns:

Edit mask - all components (both used and unused).

getMaskUsed

public final java.lang.String getMaskUsed()

Returns used components of edit mask.

Returns:

Edit mask - used components only.