Класс LookAndFeel

LookAndFeel, как следует из названия, инкапсулирует вид и ощущения. Помимо установки вида и ощущений, большинство разработчиков никогда не взаимодействуют напрямую с LookAndFeel. Как правило, только разработчики, создающие пользовательский вид и ощущения, должны интересоваться этим классом.

Swing построен на основе того, что каждый подкласс JComponent имеет реализацию определенного подкласса ComponentUI. Подкласс ComponentUI часто упоминается как «ui», «компонентный ui» или «делегат вида и ощущений». Подкласс ComponentUI отвечает за предоставление функциональности, специфичной для вида и ощущений компонента. Например, JTree требует реализации подкласса ComponentUI TreeUI. Реализация определенного подкласса ComponentUI предоставляется LookAndFeel. Каждый подкласс JComponent определяет подкласс ComponentUI , который он требует, с помощью метода JComponent getUIClassID.

Каждая реализация LookAndFeel должна предоставить реализацию соответствующего подкласса ComponentUI , указав значение для каждого идентификатора класса ui Swing в объекте UIDefaults , возвращаемом getDefaults. Например, BasicLookAndFeel использует BasicTreeUI в качестве конкретной реализации для TreeUI. Это достигается путем предоставления пары «ключ-значение» "TreeUI"-"javax.swing.plaf.basic.BasicTreeUI" в UIDefaults , возвращенном из getDefaults. См. UIDefaults.getUI(JComponent) для получения подробностей о том, как получить реализацию подкласса ComponentUI.

При установке LookAndFeel UIManager не проверяет, существует ли запись для всех идентификаторов класса ui. Поэтому могут возникнуть случайные исключения, если текущий вид и ощущения не предоставили значение для определенного идентификатора класса ui и создается экземпляр подкласса JComponent.

Рекомендации по видам и ощущениям

ComponentUIs и значения по умолчанию

Для примитивных значений, таких как opaque, следует вызвать метод installProperty. installProperty изменяет соответствующее свойство только в том случае, если значение не было изменено разработчиком.

Реализации ComponentUI должны использовать различные методы установки, предоставляемые этим классом, поскольку они обрабатывают необходимую проверку и устанавливают свойство в соответствии с рекомендуемыми правилами.

Исключения

JComponent c;
   Font font = c.getFont();
   if (font == null || (font instanceof UIResource)) {
       c.setFont(UIManager.getFont("fontKey"));
   }

Конструкторы

LookAndFeel

public LookAndFeel()

Методы

installColors

public static void installColors(JComponent c,
                                 String defaultBgName,
                                 String defaultFgName)

Удобный метод для установки свойств цвета переднего и заднего плана компонента со значениями по умолчанию. Свойства устанавливаются только в том случае, если текущее значение равно либо null либо UIResource.

Параметры:

c - компонент, на котором устанавливаются цвета

defaultBgName - ключ для заднего фона

defaultFgName - ключ для переднего плана

Исключения:

NullPointerException - как описано в исключениях

См. также:

installColorsAndFont(javax.swing.JComponent, java.lang.String, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object)

installColorsAndFont

public static void installColorsAndFont(JComponent c,
                                        String defaultBgName,
                                        String defaultFgName,
                                        String defaultFontName)

Удобный метод для установки свойств цвета переднего и заднего плана, а также шрифта компонента со значениями по умолчанию. Свойства устанавливаются только в том случае, если текущее значение равно либо null или UIResource.

Параметры:

c - компонент, на котором устанавливаются цвета и шрифт

defaultBgName - ключ для заднего фона

defaultFgName - ключ для переднего плана

defaultFontName - ключ для шрифта

Исключения:

NullPointerException - как описано в исключениях

См. также:

installColors(javax.swing.JComponent, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object), UIManager.getFont(java.lang.Object)

installBorder

public static void installBorder(JComponent c,
                                 String defaultBorderName)

Удобный метод для установки свойства границы компонента со значением из параметров по умолчанию. Граница устанавливается только если граница равна null или является экземпляром UIResource.

Параметры:

c - компонент, на котором устанавливается граница

defaultBorderName - ключ, определяющий границу

Исключения:

NullPointerException - как описано в исключениях

uninstallBorder

public static void uninstallBorder(JComponent c)

Удобный метод для удаления границы. Если граница компонента является UIResource, она устанавливается в null.

Параметры:

c - компонент, с которого удаляется граница

Исключения:

NullPointerException - если c является null

installProperty

public static void installProperty(JComponent c,
                                   String propertyName,
                                   Object propertyValue)

Удобный метод для установки свойства с указанным именем и значением на компоненте, если это свойство еще не было установлено разработчиком. Этот метод предназначен для использования экземплярами делегатов пользовательского интерфейса, которым необходимо указать значение по умолчанию для свойства примитивного типа (boolean, int, ...), но не нужно переопределять значение, установленное клиентом. Поскольку значения свойств примитивных типов не могут быть обернуты маркером UIResource, этот метод использует внутреннее состояние для определения, было ли свойство установлено клиентом.

Параметры:

c - целевой компонент для установки свойства

propertyName - имя устанавливаемого свойства

propertyValue - значение свойства

Исключения:

IllegalArgumentException - если указанное свойство не может быть установлено с помощью этого метода

ClassCastException - если значение свойства не было установлено разработчиком и тип не соответствует типу свойства

NullPointerException - если c равно null, или имя свойства не было установлено разработчиком, и propertyValue равно null

С:

1.5

makeKeyBindings

public static JTextComponent.KeyBinding[] makeKeyBindings(Object[] keyBindingList)

JTextComponent.KeyBinding[] multilineBindings = makeKeyBindings( new Object[] {
          "UP", DefaultEditorKit.upAction,
        "DOWN", DefaultEditorKit.downAction,
     "PAGE_UP", DefaultEditorKit.pageUpAction,
   "PAGE_DOWN", DefaultEditorKit.pageDownAction,
       "ENTER", DefaultEditorKit.insertBreakAction,
         "TAB", DefaultEditorKit.insertTabAction
  });

Параметры:

keyBindingList - массив пар key-action

Возвращает:

массив KeyBindings

Исключения:

NullPointerException - если keyBindingList равно null

ClassCastException - если часть key пары не является KeyStroke или String, или часть action пары не является String

См. также:

ActionMap, InputMap, KeyStroke.getKeyStroke(char)

makeInputMap

public static InputMap makeInputMap(Object[] keys)

Создаёт InputMapUIResource из keys. Это удобный метод для создания нового InputMapUIResource, вызова loadKeyBindings(map, keys) и возвращения InputMapUIResource.

Параметры:

keys - чередующиеся пары keystroke-action key пар, как описано в loadKeyBindings(javax.swing.InputMap, java.lang.Object[])

Возвращает:

новосозданный и заполненный InputMapUIResource

С:

1.3

См. также:

loadKeyBindings(javax.swing.InputMap, java.lang.Object[])

makeComponentInputMap

public static ComponentInputMap makeComponentInputMap(JComponent c,
                                                      Object[] keys)

Создаёт ComponentInputMapUIResource из keys. Это удобный метод для создания нового ComponentInputMapUIResource, вызова loadKeyBindings(map, keys) и возвращения ComponentInputMapUIResource.

Параметры:

c - компонент для создания ComponentInputMapUIResource

keys - чередующиеся пары keystroke-action key пар, как описано в loadKeyBindings(javax.swing.InputMap, java.lang.Object[])

Возвращает:

новосозданный и заполненный InputMapUIResource

Исключения:

IllegalArgumentException - если c равно null

С:

1.3

См. также:

loadKeyBindings(javax.swing.InputMap, java.lang.Object[]), ComponentInputMapUIResource

loadKeyBindings

public static void loadKeyBindings(InputMap retMap,
                                   Object[] keys)

LookAndFeel.loadKeyBindings(inputMap, new Object[] {
     "control X", "cut",
     "control V", "paste"
   });

Параметры:

retMap - InputMap для добавления пар key-action

keys - привязки для добавления к retMap

Исключения:

NullPointerException - если keys равно non-null, не пусто, и retMap равно null

С:

1.3

См. также:

KeyStroke.getKeyStroke(String), InputMap

makeIcon

public static Object makeIcon(Class<?> baseClass,
                              String gifFile)

Параметры:

baseClass - Class используется для загрузки ресурса

gifFile - путь к изображению для загрузки

Возвращает:

объект UIDefaults.LazyValue; при разрешении LazyValue загружает указанное изображение

См. также:

UIDefaults.LazyValue, Icon, Class.getResourceAsStream(String)

getLayoutStyle

public LayoutStyle getLayoutStyle()

Возвращает:

стиль LayoutStyle для данного стиля оформления

С:

1.6

См. также:

LayoutStyle.getInstance()

provideErrorFeedback

public void provideErrorFeedback(Component component)

Вызывается, когда пользователь пытается выполнить недопустимую операцию, например, вставить данные в недоступное для редактирования JTextField с фокусом. По умолчанию издаётся звуковой сигнал. Подклассы, желающие другого поведения, должны переопределить этот метод и предоставить дополнительную обратную связь.

Параметры:

component - Component компонент, в котором произошла ошибка, может быть null , указывающий на то, что состояние ошибки не напрямую связано с Component

С:

1.4

getDesktopPropertyValue

public static Object getDesktopPropertyValue(String systemPropertyName,
                                             Object fallbackValue)

Возвращает значение указанной системной свойства рабочего стола, вызывая Toolkit.getDefaultToolkit().getDesktopProperty(). Если значение указанного свойства null, возвращается fallbackValue.

Параметры:

systemPropertyName - имя системной свойства рабочего стола, которое запрашивается

fallbackValue - объект, который должен быть возвращён в качестве значения, если системное значение равно null

Возвращает:

текущее значение свойства рабочего стола

С:

1.4

См. также:

Toolkit.getDesktopProperty(java.lang.String)

getDisabledIcon

public Icon getDisabledIcon(JComponent component,
                            Icon icon)

Параметры:

component - JComponent компонент, который будет отображать Icon, может быть null

icon - Icon для генерации отключённого значка

Возвращает:

отключённый Icon, или null если подходящий Icon не может быть сгенерирован

С:

1.5

getDisabledSelectedIcon

public Icon getDisabledSelectedIcon(JComponent component,
                                    Icon icon)

Параметры:

component - JComponent компонент, который будет отображать Icon, может быть null

icon - Icon для генерации отключённого и выбранного значка

Возвращает:

отключённый и выбранный значок, или null если подходящий Icon не может быть сгенерирован.

С:

1.5

getName

public abstract String getName()

Возвращает короткую строку, идентифицирующую этот стиль оформления, например, "CDE/Motif". Эта строка должна быть подходящей для пункта меню. Различные стили оформления должны иметь разные имена, например, подкласс MotifLookAndFeel, изменяющий отображение нескольких компонентов, должен называться "CDE/Motif My Way"; это полезно пользователю при выборе стиля оформления из списка имён.

Возвращает:

короткое имя стиля оформления

getID

public abstract String getID()

Возвращает строку, идентифицирующую этот стиль оформления. Эта строка будет использоваться приложениями/службами, которые хотят распознать известные реализации стилей оформления. В настоящее время известные имена - "Motif", "Windows", "Mac", "Metal". Обратите внимание, что стиль оформления, полученный от известного суперкласса, который не вносит фундаментальных изменений в вид или ощущение, не должен переопределять этот метод.

Возвращает:

идентификатор стиля оформления

getDescription

public abstract String getDescription()

Возвращает однострочное описание реализации этого стиля оформления, например, "Стиль оформления CDE/Motif". Эта строка предназначена для пользователя, например, в заголовке окна или в сообщении подсказки.

Возвращает:

краткое описание стиля оформления

getSupportsWindowDecorations

public boolean getSupportsWindowDecorations()

Возвращает:

true если RootPaneUI экземпляры, созданные этим стилем оформления, поддерживают украшения на стороне клиента

С:

1.4

См. также:

JDialog.setDefaultLookAndFeelDecorated(boolean), JFrame.setDefaultLookAndFeelDecorated(boolean), JRootPane.setWindowDecorationStyle(int)

isNativeLookAndFeel

public abstract boolean isNativeLookAndFeel()

Если в базовой платформе есть "родной" стиль оформления, и это его реализация, вернуть true. Например, когда базовая платформа Solaris с CDE, реализация стиля оформления CDE/Motif вернёт true.

Возвращает:

true если этот стиль оформления представляет собой базовый стиль оформления платформы

isSupportedLookAndFeel

public abstract boolean isSupportedLookAndFeel()

Возвращает true, если базовая платформа поддерживает или разрешает данный стиль оформления. Этот метод возвращает false, если стиль оформления зависит от специальных ресурсов или соглашений, которые не определены для текущей платформы.

Возвращает:

true если это поддерживаемый стиль оформления

См. также:

UIManager.setLookAndFeel(javax.swing.LookAndFeel)

initialize

public void initialize()

Инициализирует стиль оформления. Хотя этот метод является публичным, его должен вызывать только UIManager при установке стиля оформления в качестве текущего. Этот метод вызывается перед тем, как UIManager вызовет getDefaults. Этот метод предназначен для выполнения любой инициализации для стиля оформления. Подклассы должны выполнять здесь любую однократную настройку, а не в статическом инициализаторе, так как объекты класса стиля оформления могут быть загружены только для того, чтобы обнаружить, что isSupportedLookAndFeel() возвращает false.

См. также:

uninitialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

uninitialize

public void uninitialize()

См. также:

initialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

getDefaults

public UIDefaults getDefaults()

Возвращает значения по умолчанию стиля оформления. Хотя этот метод является публичным, его должен вызывать только UIManager при установке стиля оформления в качестве текущего и после того, как initialize был вызван.

Возвращает:

значения по умолчанию стиля оформления

См. также:

initialize(), uninitialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

toString

public String toString()

Возвращает строку, отображающую и идентифицирующую свойства этого объекта.

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого объекта