Search this API

y.option
Class StringOptionItem

java.lang.Object
  extended by y.option.OptionItem
      extended by y.option.ObjectOptionItem
          extended by y.option.StringBasedOptionItem
              extended by y.option.StringOptionItem
All Implemented Interfaces:
AttributeOwner, BackupValueOwner, PropertyChangeReporter, VetoableChangeReporter

public class StringOptionItem
extends StringBasedOptionItem

An option item for Strings.

 

Field Summary
static java.lang.String ATTRIBUTE_COLUMNS
          Attribute key used to store an editor hint specifying how many columns the editor should have.
static java.lang.String ATTRIBUTE_POPUP_COLUMNS
           
static java.lang.String ATTRIBUTE_POPUP_ROWS
           
static java.lang.String ATTRIBUTE_ROWS
          Attribute key used to store an editor hint specifying how many rows the editor should have.
 
Fields inherited from class y.option.StringBasedOptionItem
ATTRIBUTE_CONVERTER, PROPERTY_CONVERTER
 
Fields inherited from class y.option.OptionItem
ATTRIBUTE_CONTEXT, ATTRIBUTE_GROUPS, ATTRIBUTE_LONG_DESCRIPTION, COLOR_UNDEFINED, name, PROPERTY_CLASS_TYPE, PROPERTY_ENABLED, PROPERTY_TIP_TEXT, PROPERTY_VALUE, PROPERTY_VALUE_UNDEFINED, UNDEFINED
 
Constructor Summary
StringOptionItem(java.lang.String name, java.lang.String value)
          Creates a new instance of StringOptionItem.
StringOptionItem(java.lang.String name, java.lang.String value, int rows)
          Creates a new instance of StringOptionItem.
 
Method Summary
 int getRows()
          Deprecated. Use getAttribute( ATTRIBUTE_ROWS ) instead.
 
Methods inherited from class y.option.StringBasedOptionItem
getConverter, getStringValue, getType, setConverter, setStringValue, setValue
 
Methods inherited from class y.option.ObjectOptionItem
getBackupValue, getValue, resetValue
 
Methods inherited from class y.option.OptionItem
addEditor, addEditorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, adoptEditorValue, checkEditorValue, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, getAttribute, getClassType, getEditor, getEditor, getEditors, getName, getTipText, isEnabled, isValueUndefined, publishEnabled, publishValue, publishValueUndefined, removeAttribute, removeEditor, removeEditorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setAttribute, setClassType, setEnabled, setTipText, setValueUndefined, wantsVisibleName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_ROWS

public static final java.lang.String ATTRIBUTE_ROWS
Attribute key used to store an editor hint specifying how many rows the editor should have. Values have to be of type Integer and positive.


ATTRIBUTE_COLUMNS

public static final java.lang.String ATTRIBUTE_COLUMNS
Attribute key used to store an editor hint specifying how many columns the editor should have. Values have to be of type Integer and positive.


ATTRIBUTE_POPUP_ROWS

public static final java.lang.String ATTRIBUTE_POPUP_ROWS

ATTRIBUTE_POPUP_COLUMNS

public static final java.lang.String ATTRIBUTE_POPUP_COLUMNS
Constructor Detail

StringOptionItem

public StringOptionItem(java.lang.String name,
                        java.lang.String value,
                        int rows)
Creates a new instance of StringOptionItem.

Parameters:
name - the name of the item
value - the initial value of the item
rows - the number of text rows of the option editor.

StringOptionItem

public StringOptionItem(java.lang.String name,
                        java.lang.String value)
Creates a new instance of StringOptionItem.

Parameters:
name - the name of the item
value - the initial value of the item
Method Detail

getRows

public int getRows()
Deprecated. Use getAttribute( ATTRIBUTE_ROWS ) instead.

Returns the number of rows this item wants its editors to have.

Returns:
the number of rows this item wants its editors to have

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.