com.izforge.izpack.panels.userinput.field.title
Class TitleField

java.lang.Object
  com.izforge.izpack.panels.userinput.field.Field
      com.izforge.izpack.panels.userinput.field.title.TitleField

public class TitleField
extends Field

Title field.

Author:

Tim Anderson

Constructor Summary

TitleField(TitleFieldConfig config, InstallData installData)
Constructs a TitleField.

Method Summary

Alignment	getAlignment() Returns the title alignment.
String	getIconId() Returns the icon identifier.
String	getIconName(Messages messages) Returns the icon name.
float	getTitleSize() Returns the title size.
boolean	isBold() Determines if the title is bold.
boolean	isItalic() Determines if the title is in italics.

Methods inherited from class com.izforge.izpack.panels.userinput.field.Field

getDefaultValue, getDescription, getDescription, getInitialValue, getInstallData, getLabel, getLabel, getOmitFromAuto, getOsModels, getPacks, getProcessors, getSize, getSummaryKey, getTooltip, getValue, getVariable, isConditionTrue, isEffectiveDisplayHidden, isEffectiveReadonly, replaceVariables, setSaving, setValue, setVariable, validate, validate, wrapDefaultValue, wrapInitialValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TitleField

public TitleField(TitleFieldConfig config,
                  InstallData installData)

Constructs a TitleField.

Parameters:

config - the field configuration

installData - the installation data

Throws:

IzPackException - if the field cannot be read

Method Detail

getIconId

public String getIconId()

Returns the icon identifier.

Returns:

the icon identifier. May be null

getIconName

public String getIconName(Messages messages)

Returns the icon name.

This tries to locate a localised name for the icon from the supplied messages, using the icon identifier as the key.

Parameters:

messages - the messages

Returns:

the icon name. May be null

isBold

public boolean isBold()

Determines if the title is bold.

Returns:

true if the title is bold

isItalic

public boolean isItalic()

Determines if the title is in italics.

Returns:

true if the title in italics

getTitleSize

public float getTitleSize()

Returns the title size.

This is used as a multiplier for the default font size.

Returns:

the title size

getAlignment

public Alignment getAlignment()

Returns the title alignment.

Returns:

the title alignment