BorderProperty

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## net.ctdp.rfdynhud.properties
Class BorderProperty

    java.lang.Object
      net.ctdp.rfdynhud.properties.Property
          net.ctdp.rfdynhud.properties.BorderProperty

    public class BorderProperty

extends Property

The `BorderProperty` serves for customizing a border.

Author:
  Marvin Froehlich (CTDP)

Field Summary
`static java.lang.String` | `DEFAULT_BORDER_NAME`

Constructor Summary
`BorderProperty(java.lang.String name, java.lang.String defaultValue)`
`BorderProperty(java.lang.String name, java.lang.String defaultValue, boolean readonly)`
`BorderProperty(java.lang.String name, java.lang.String defaultValue, IntProperty paddingTop, IntProperty paddingLeft, IntProperty paddingRight, IntProperty paddingBottom)`
`BorderProperty(java.lang.String name, java.lang.String nameForDisplay, java.lang.String defaultValue)`
`BorderProperty(java.lang.String name, java.lang.String nameForDisplay, java.lang.String defaultValue, boolean readonly)`
`BorderProperty(java.lang.String name, java.lang.String nameForDisplay, java.lang.String defaultValue, boolean readonly, IntProperty paddingTop, IntProperty paddingLeft, IntProperty paddingRight, IntProperty paddingBottom)`

Method Summary
`BorderWrapper` | `getBorder()` Gets the selected border.
`java.lang.String` | `getBorderAlias()` Gets the property's current value.
`static java.lang.String` | `getDefaultBorderValue(java.lang.String name)`
`java.lang.String` | `getValue()` Gets the current value fo this property.
`java.lang.Object` | `getValueForConfigurationFile()` Gets the value prepared for the configuration file.
`void` | `loadValue(PropertyLoader loader, java.lang.String value)` Loads the value from the configuration file.
`protected void` | `onKeeperSet()`
`protected void` | `onValueChanged(java.lang.String oldValue, java.lang.String newValue)` Invoked when the value has changed.
`void` | `refresh()` Must be called after border aliases have changed in the editor.
`boolean` | `setBorder(java.lang.String borderAliasOrName)` Sets the property's value.
`protected boolean` | `setBorder(java.lang.String borderAliasOrName, boolean firstTime)` Sets the property's value.
`void` | `setValue(java.lang.Object value)` Sets the new value for this property.

Methods inherited from class net.ctdp.rfdynhud.properties.Property
`getButtonText, getButtonTooltip, getDocumentationSource, getEditorType, getKeeper, getName, getNameForDisplay, isMatchingKey, isReadOnly, onButtonClicked, quoteValueInConfigurationFile, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### DEFAULT_BORDER_NAME

    public static final java.lang.String DEFAULT_BORDER_NAME

See Also:
  Constant Field Values

Constructor Detail

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String nameForDisplay,
                          java.lang.String defaultValue,
                          boolean readonly,
                          IntProperty paddingTop,
                          IntProperty paddingLeft,
                          IntProperty paddingRight,
                          IntProperty paddingBottom)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`.
  `nameForDisplay` - the name displayed in the editor. See `Property.getNameForDisplay()`. If `null` is passed, the value of the name parameter is used.
  `defaultValue` - the default value
  `readonly` - read only property?
  `paddingTop` -
  `paddingLeft` -
  `paddingRight` -
  `paddingBottom` -

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String defaultValue,
                          IntProperty paddingTop,
                          IntProperty paddingLeft,
                          IntProperty paddingRight,
                          IntProperty paddingBottom)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`. 'nameForDisplay' is set to the same value.
  `defaultValue` - the default value
  `paddingTop` - top padding property
  `paddingLeft` - left padding property
  `paddingRight` - right padding property
  `paddingBottom` - bottom padding property

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String nameForDisplay,
                          java.lang.String defaultValue,
                          boolean readonly)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`.
  `nameForDisplay` - the name displayed in the editor. See `Property.getNameForDisplay()`. If `null` is passed, the value of the name parameter is used.
  `defaultValue` - the default value
  `readonly` - read only property?

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String nameForDisplay,
                          java.lang.String defaultValue)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`.
  `nameForDisplay` - the name displayed in the editor. See `Property.getNameForDisplay()`. If `null` is passed, the value of the name parameter is used.
  `defaultValue` - the default value

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String defaultValue,
                          boolean readonly)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`. 'nameForDisplay' is set to the same value.
  `defaultValue` - the default value
  `readonly` - read only property?

### BorderProperty

    public BorderProperty(java.lang.String name,
                          java.lang.String defaultValue)

Parameters:
  `name` - the technical name used internally. See `Property.getName()`. 'nameForDisplay' is set to the same value.
  `defaultValue` - the default value

Method Detail

### getDefaultBorderValue

    public static java.lang.String getDefaultBorderValue(java.lang.String name)

### onKeeperSet

    protected void onKeeperSet()

  Overrides:
    `onKeeperSet` in class `Property`

### onValueChanged

    protected void onValueChanged(java.lang.String oldValue,
                                  java.lang.String newValue)

  Invoked when the value has changed.

  Parameters:
    `oldValue` - the old value
    `newValue` - the new value

### refresh

    public void refresh()

  Must be called after border aliases have changed in the editor.

### setBorder

    protected final boolean setBorder(java.lang.String borderAliasOrName,
                                      boolean firstTime)

  Sets the property's value.

  Parameters:
    `borderAliasOrName` - the new border
    `firstTime` -
  Returns:
    changed?

### setBorder

    public final boolean setBorder(java.lang.String borderAliasOrName)

  Sets the property's value.

  Parameters:
    `borderAliasOrName` - the new border
  Returns:
    changed?

### getBorderAlias

    public final java.lang.String getBorderAlias()

  Gets the property's current value.

  Returns:
    the property's current value.

### getBorder

    public final BorderWrapper getBorder()

  Gets the selected border.

  Returns:
    the selected border.

### setValue

    public void setValue(java.lang.Object value)

  Sets the new value for this property.

  Specified by:
    `setValue` in class `Property`
  Parameters:
    `value` - the new value

### getValue

    public java.lang.String getValue()

  Gets the current value fo this property.

  Specified by:
    `getValue` in class `Property`
  Returns:
    the current value fo this property.

### getValueForConfigurationFile

    public java.lang.Object getValueForConfigurationFile()

  Gets the value prepared for the configuration file. This can be a String or some other primitive value.

  Overrides:
    `getValueForConfigurationFile` in class `Property`
  Returns:
    the value prepared for the configuration file.

### loadValue

    public void loadValue(PropertyLoader loader,
                          java.lang.String value)

  Loads the value from the configuration file.

  Specified by:
    `loadValue` in class `Property`
  Parameters:
    `loader` - the loader
    `value` - the value to load

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD