de.kleopatra.view.presentation
Interface PresentationDescription

All Known Implementing Classes:
DefaultPresentationDescription

public interface PresentationDescription

Represent set of general presentation attributes.

PresentationID is id to link all kinds of descriptions (layout, binding, ...) Common attributes are: text, tooltip, accelerator, help text, tooltip text, mnemonic, small icon. They are accessible via dedicated getters/setters.

Extended attributes are handled via key/value pairs in get/setPresentationAttribute.

NOTE: attribute keys can be added on request.

CHANGED: the string values of the keys are changed to be the same as the properties they represent. Please let me know if that's a problem in older resources (should not, because the property is saved).

Version:
$Revision: 1.1.1.1 $ - $Date: 2004/08/19 11:18:34 $
Author:
(C) Jeanette Winzenburg, Berlin

Field Summary
static java.lang.String ACCELERATOR_KEY
          common attribute: key for accelerator.
static java.lang.String FORMAT_MASK_KEY
          extended attribute: key for formatting mask.
static java.lang.String HELP_TEXT_KEY
          common attribute: key for help text.
static java.lang.String ICON_KEY
          common attribute: key for small icon.
static java.lang.String MASK_KEY
          extended attribute: key for formatting mask.
static java.lang.String MNEMONIC_KEY
          common attribute: key for mnemonic.
static java.lang.String TEXT_KEY
          common attribute: key for text/label.
static java.lang.String TOOL_TIP_TEXT_KEY
          common attribute: key for tooltip.
 
Method Summary
 void clearAttributes()
           
 java.lang.String getAccelerator()
           
 java.lang.String getAttribute(java.lang.String attributeKey)
           
 java.util.List getAttributeKeys()
           
 java.lang.String getHelpText()
           
 java.lang.String getIcon()
           
 java.lang.String getMnemonic()
           
 java.lang.Object getPresentationID()
          meant to be immutable.
 java.lang.String getText()
           
 java.lang.String getToolTipText()
           
 void setAccelerator(java.lang.String keyStrokeText)
           
 void setAttribute(java.lang.String attributeKey, java.lang.String attributeValue)
           
 void setHelpText(java.lang.String text)
           
 void setIcon(java.lang.String iconFile)
           
 void setMnemonic(java.lang.String mnemonic)
           
 void setPresentationID(java.lang.Object id)
          need for editing...
 void setText(java.lang.String text)
           
 void setToolTipText(java.lang.String text)
           
 

Field Detail

ACCELERATOR_KEY

public static final java.lang.String ACCELERATOR_KEY
common attribute: key for accelerator.

See Also:
Constant Field Values

TEXT_KEY

public static final java.lang.String TEXT_KEY
common attribute: key for text/label. NOTE: the constant name formerly was NAME_TEXT.

See Also:
Constant Field Values

HELP_TEXT_KEY

public static final java.lang.String HELP_TEXT_KEY
common attribute: key for help text.

See Also:
Constant Field Values

TOOL_TIP_TEXT_KEY

public static final java.lang.String TOOL_TIP_TEXT_KEY
common attribute: key for tooltip.

See Also:
Constant Field Values

MNEMONIC_KEY

public static final java.lang.String MNEMONIC_KEY
common attribute: key for mnemonic.

See Also:
Constant Field Values

ICON_KEY

public static final java.lang.String ICON_KEY
common attribute: key for small icon.

See Also:
Constant Field Values

MASK_KEY

public static final java.lang.String MASK_KEY
extended attribute: key for formatting mask.

See Also:
Constant Field Values

FORMAT_MASK_KEY

public static final java.lang.String FORMAT_MASK_KEY
extended attribute: key for formatting mask.

See Also:
Constant Field Values
Method Detail

getPresentationID

public java.lang.Object getPresentationID()
meant to be immutable. so no public setter.


setPresentationID

public void setPresentationID(java.lang.Object id)
need for editing...


getText

public java.lang.String getText()

getToolTipText

public java.lang.String getToolTipText()

getHelpText

public java.lang.String getHelpText()

getAccelerator

public java.lang.String getAccelerator()

getMnemonic

public java.lang.String getMnemonic()

getIcon

public java.lang.String getIcon()

getAttribute

public java.lang.String getAttribute(java.lang.String attributeKey)

setText

public void setText(java.lang.String text)

setToolTipText

public void setToolTipText(java.lang.String text)

setHelpText

public void setHelpText(java.lang.String text)

setAccelerator

public void setAccelerator(java.lang.String keyStrokeText)

setMnemonic

public void setMnemonic(java.lang.String mnemonic)

setIcon

public void setIcon(java.lang.String iconFile)

setAttribute

public void setAttribute(java.lang.String attributeKey,
                         java.lang.String attributeValue)

clearAttributes

public void clearAttributes()

getAttributeKeys

public java.util.List getAttributeKeys()


Copyright © 2003, 2004 SwingEmpire Jeanette Winzenburg. All Rights Reserved.