com.f1j.ss
Interface ProtectionFormat

public interface ProtectionFormat

extends FormatBase

The Protection Format interface.

Inner Class Summary

static class

ProtectionFormat.EProperty Protection Format property enumeration

Field Summary

static ProtectionFormat.EProperty	eHidden Hidden property
static ProtectionFormat.EProperty	eLocked Locked property
static ProtectionFormat.EProperty	eLockText Lock text property

Method Summary

boolean	isHidden() Returns whether formulas are hidden.
boolean	isLocked() Returns whether the active cell is locked.
boolean	isLockText() Returns whether the selected object's text is locked.
void	setHidden(boolean hidden) Sets the display status of an element.
void	setLocked(boolean locked) Sets the locked cell flag.
void	setLockText(boolean lockText) Sets whether or not the selected object's text is locked.

Methods inherited from interface com.f1j.util.FormatBase

isUndefined, isUndefined, isUsed, setUndefined, undefineAll, useAll

Field Detail

eHidden

public static final ProtectionFormat.EProperty eHidden

Hidden property

eLocked

public static final ProtectionFormat.EProperty eLocked

Locked property

eLockText

public static final ProtectionFormat.EProperty eLockText

Lock text property

Method Detail

isHidden

public boolean isHidden()

Returns whether formulas are hidden.

Returns:

boolean. true = hidden. false = not hidden.

See Also:

setHidden(boolean)

isLocked

public boolean isLocked()

Returns whether the active cell is locked.

Returns:

boolean. true = locked. false = not locked.

See Also:

setLocked(boolean)

isLockText

public boolean isLockText()

Returns whether the selected object's text is locked.

Returns:

boolean. true = locked. false = not locked.

See Also:

setLockText(boolean)

setHidden

public void setHidden(boolean hidden)
               throws InvalidArgumentException,
                      F1Exception

Sets the display status of an element.

Parameters:

hidden - boolean. true = hidden. false = visible.

See Also:

isHidden()

setLocked

public void setLocked(boolean locked)

Sets the locked cell flag.

Parameters:

locked - boolean. true = lock the cell. false = unlock the cell.

See Also:

isLocked()

setLockText

public void setLockText(boolean lockText)
                 throws InvalidArgumentException,
                        F1Exception

Sets whether or not the selected object's text is locked.

Parameters:

lockText - boolean. true = lock the text. false = unlock the text.

See Also:

isLockText()