org.vishia.util

Interface MarkMask_ifc

All Known Implementing Classes:

FileMark, FileRemote, FileZip, SelectMask

public interface MarkMask_ifc

This is a universal interface to mark instances to support selection. It supports up to 32 sources or users for mark. The management of users should be defined at user level. A source is represented by a bit in the 32-bit-value of the mask. Usual only one source for selection may existing. It is possible that two or less more sources do a mark independently. The class SelectMask is the standard implementation. A derived class can inheritance from that class if another superclass isn't necessary. This may be usual for small data classes.

Usage of the oData parameter:

 Application
     |--------->MarkMask_ifc
     |                |<|----Implementor
                      |      maybe a table container
                      |             |--oData---------->SelectMask_ifc
                                                           |<|-----------SecondImplementor
                                                           |             maybe an Object
                                                                         which should be
                                                                         selected
 

The oData maybe instance of SelectMask_ifc, but maybe another one, depends on the first Implementor.

Field Summary

Fields

Modifier and Type	Field and Description
static int	version Version, history and license.

Method Summary

Modifier and Type	Method and Description
int	getMark() Returns the selection mask of this object.
int	setMarked(int mask, java.lang.Object data) Sets the mark bits of the object for the given source.
int	setNonMarked(int mask, java.lang.Object data) Removes the mark bits of the object for the given source.

Field Detail

version

static final int version

Version, history and license.

• 2013-04-28 Hartmut rename: This interface is called now 'MarkMask_ifc' instead 'SelectMask_ifc'. It is a problem of wording: The instances are only marked, not yet 'selected'. See application of this interface in org.vishia.gral.widget.GralFileSelector: A selected line is the current one or some marked lines.
• 2013-04-28 Hartmut chg: Use the mask for selection of mark bits.
• 2013-04-28 Hartmut chg: new parameter data proper to use. Adaption necessary. Left it empty if it don't need.
• 2011-11-28 Hartmut creation

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

getMark

int getMark()

Returns the selection mask of this object. If the returned value is 0, the object is not selected. If it is not 0, any source (represented by each bit) has selected this source.

Returns:

bits of selection, 0 if it is not selected.

setNonMarked

int setNonMarked(int mask,
                 java.lang.Object data)

Removes the mark bits of the object for the given source.

Parameters:

mask - The bit which presents the source.

oData - data which are given with this mark. Maybe the mark should be done in this data too. It depends on usage and implementation.

Returns:

The mark bits before this action is done.

setMarked

int setMarked(int mask,
              java.lang.Object data)

Sets the mark bits of the object for the given source.

Parameters:

mask - The bit which presents the source.

oData - data which are given with this mark. Maybe the mark should be done in this data too. It depends on usage and implementation.

Returns:

The mark bits before this action is done. If it is 0, this source is the only one which has marks the object.