Files
XRLib/Assets/Scripts/UVC/UIToolkit/Input/UTKIntegerField.cs
2026-02-24 20:01:56 +09:00

371 lines
12 KiB
C#

#nullable enable
using System;
using UnityEngine;
using UnityEngine.UIElements;
namespace UVC.UIToolkit
{
/// <summary>
/// 정수(int) 입력 필드 컴포넌트.
/// Unity IntegerField를 래핑하여 커스텀 스타일을 적용합니다.
/// -2,147,483,648 ~ 2,147,483,647 범위의 정수를 입력받습니다.
/// </summary>
/// <remarks>
/// <para><b>int(정수)란?</b></para>
/// <para>int는 32비트 부호 있는 정수 타입으로, 소수점이 없는 숫자를 저장합니다.</para>
/// <list type="bullet">
/// <item><description>개수, 수량, 인덱스 등 정수 값에 사용</description></item>
/// <item><description>큰 숫자가 필요하면 UTKLongField 사용</description></item>
/// <item><description>소수점이 필요하면 UTKFloatField 사용</description></item>
/// <item><description>Validation 함수를 통한 입력 검증 (FocusOut 시 자동 호출)</description></item>
/// <item><description>에러 상태 시 붉은 외곽선 + 에러 메시지 표시</description></item>
/// </list>
/// </remarks>
/// <example>
/// <para><b>C# 코드에서 사용:</b></para>
/// <code>
/// // 기본 정수 필드 생성
/// var intField = new UTKIntegerField();
/// intField.label = "수량";
/// intField.Value = 10;
///
/// // 값 변경 이벤트
/// intField.OnValueChanged += (value) => {
/// Debug.Log($"수량: {value}");
/// };
///
/// // 라벨과 기본값을 지정하는 생성자
/// var countField = new UTKIntegerField("아이템 개수", 5);
///
/// // 현재 값 읽기/쓰기
/// int currentValue = intField.Value;
/// intField.Value = 20;
///
/// // 비활성화
/// intField.IsEnabled = false;
/// </code>
/// <para><b>Validation (입력 검증):</b></para>
/// <code>
/// // 검증 함수 설정 (Func<bool>)
/// var ageField = new UTKIntegerField("나이", 0);
/// ageField.ErrorMessage = "나이는 1~150 사이여야 합니다.";
/// ageField.Validation = () => ageField.Value >= 1 &amp;&amp; ageField.Value <= 150;
/// // → FocusOut 시 자동으로 검증
/// // → 실패 시 붉은 외곽선 + 에러 메시지 표시, 통과 시 자동 해제
///
/// // 양수만 허용
/// var quantityField = new UTKIntegerField("수량", 0);
/// quantityField.ErrorMessage = "수량은 0보다 커야 합니다.";
/// quantityField.Validation = () => quantityField.Value > 0;
///
/// // 강제 검증 호출 (예: 폼 제출 버튼 클릭 시)
/// bool isValid = ageField.Validate();
/// if (!isValid) return; // 검증 실패
///
/// // 에러 수동 해제
/// ageField.ClearError();
///
/// // 에러 메시지 직접 설정 (Validation 없이, 서버 오류 등)
/// intField.ErrorMessage = "서버 오류가 발생했습니다.";
/// intField.ErrorMessage = ""; // 오류 제거
/// </code>
/// <para><b>UXML에서 사용:</b></para>
/// <code><![CDATA[
/// <!-- 기본 정수 필드 -->
/// <utk:UTKIntegerField label="수량" value="10" />
///
/// <!-- 비활성화 상태 -->
/// <utk:UTKIntegerField label="고정 값" value="100" is-enabled="false" />
///
/// <!-- label min-width 설정 -->
/// <utk:UTKIntegerField label="수량" label-min-width="120" />
/// ]]></code>
/// <para><b>Label Min-Width 설정:</b></para>
/// <code>
/// // label이 있을 때 .unity-label의 min-width를 설정
/// var intField = new UTKIntegerField("수량");
/// intField.LabelMinWidth = 120f; // 120px
/// </code>
/// <para><b>실제 활용 예시 (인벤토리 수량):</b></para>
/// <code>
/// // 인벤토리 아이템 수량 편집
/// var quantityField = new UTKIntegerField("보유 수량", item.Quantity);
/// quantityField.ErrorMessage = "수량은 0 이상이어야 합니다.";
/// quantityField.Validation = () => quantityField.Value >= 0;
/// quantityField.OnValueChanged += (newQty) => {
/// item.Quantity = newQty;
/// UpdateInventoryUI();
/// };
/// </code>
/// </example>
[UxmlElement]
public partial class UTKIntegerField : IntegerField, IDisposable
{
#region Constants
private const string USS_PATH = "UIToolkit/Input/UTKIntegerField";
#endregion
#region Fields
private bool _disposed;
private bool _isEnabled = true;
private string _errorMessage = "";
private float _labelMinWidth = -1f;
private Func<bool>? _validation;
private Label? _errorLabel;
#endregion
#region Events
/// <summary>값 변경 이벤트</summary>
public event Action<int>? OnValueChanged;
#endregion
#region Properties
/// <summary>현재 값</summary>
public int Value
{
get => value;
set => this.value = value;
}
/// <summary>에러 메시지. 비어있지 않으면 에러 상태로 표시</summary>
[UxmlAttribute("error-message")]
public string ErrorMessage
{
get => _errorMessage;
set
{
_errorMessage = value;
var hasError = !string.IsNullOrEmpty(value);
EnableInClassList("utk-integer-field--error", hasError);
UpdateErrorLabel(hasError ? value : null);
}
}
/// <summary>검증 함수. FocusOut 시 호출되어 false 반환 시 ErrorMessage 표시</summary>
public Func<bool>? Validation
{
get => _validation;
set => _validation = value;
}
/// <summary>활성화 상태</summary>
[UxmlAttribute("is-enabled")]
public bool IsEnabled
{
get => _isEnabled;
set
{
_isEnabled = value;
SetEnabled(value);
EnableInClassList("utk-integer-field--disabled", !value);
}
}
/// <summary>label이 있을 때 .unity-label의 min-width (px). -1이면 미설정</summary>
[UxmlAttribute("label-min-width")]
public float LabelMinWidth
{
get => _labelMinWidth;
set
{
_labelMinWidth = value;
ApplyLabelMinWidth();
}
}
/// <summary>
/// 읽기 전용
/// </summary>
public new bool isReadOnly
{
get => base.isReadOnly;
set
{
base.isReadOnly = value;
EnableInClassList("utk-integer-field--readonly", value);
}
}
#endregion
#region Constructor
public UTKIntegerField() : base()
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
var uss = Resources.Load<StyleSheet>(USS_PATH);
if (uss != null)
{
styleSheets.Add(uss);
}
SetupStyles();
SetupEvents();
SubscribeToThemeChanges();
}
public UTKIntegerField(string label, int defaultValue = 0) : this()
{
this.label = label;
value = defaultValue;
}
#endregion
#region Setup
private void SetupStyles()
{
AddToClassList("utk-integer-field");
// label 설정 후 LabelMinWidth 적용
schedule.Execute(() => ApplyLabelMinWidth());
}
private void SetupEvents()
{
RegisterCallback<ChangeEvent<int>>(OnFieldValueChanged);
RegisterCallback<FocusOutEvent>(OnFocusOut);
RegisterCallback<KeyDownEvent>(OnKeyDown, TrickleDown.TrickleDown);
}
private void SubscribeToThemeChanges()
{
UTKThemeManager.Instance.OnThemeChanged += OnThemeChanged;
RegisterCallback<AttachToPanelEvent>(OnAttachToPanelForTheme);
RegisterCallback<DetachFromPanelEvent>(OnDetachFromPanelForTheme);
}
private void OnAttachToPanelForTheme(AttachToPanelEvent evt)
{
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
UTKThemeManager.Instance.OnThemeChanged += OnThemeChanged;
UTKThemeManager.Instance.ApplyThemeToElement(this);
}
private void OnDetachFromPanelForTheme(DetachFromPanelEvent evt)
{
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
}
private void OnThemeChanged(UTKTheme theme)
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
}
private void ApplyLabelMinWidth()
{
if (string.IsNullOrEmpty(label)) return;
var labelElement = this.Q<Label>(className: "unity-label");
if (labelElement == null) return;
if (_labelMinWidth >= 0)
{
labelElement.style.minWidth = _labelMinWidth;
}
else
{
labelElement.style.minWidth = StyleKeyword.Null;
}
}
#endregion
#region Event Handlers
private void OnFieldValueChanged(ChangeEvent<int> evt)
{
OnValueChanged?.Invoke(evt.newValue);
}
private void OnFocusOut(FocusOutEvent evt)
{
RunValidation();
}
private void OnKeyDown(KeyDownEvent evt)
{
if (evt.keyCode == KeyCode.Return)
{
RunValidation();
}
}
#endregion
#region Methods
/// <summary>
/// 강제로 Validation을 실행하여 에러 상태를 업데이트합니다.
/// </summary>
/// <returns>Validation이 null이면 true, 아니면 Validation 결과</returns>
public bool Validate()
{
return RunValidation();
}
/// <summary>에러 상태를 수동으로 해제합니다.</summary>
public void ClearError()
{
ErrorMessage = "";
}
private bool RunValidation()
{
if (_validation == null) return true;
var isValid = _validation.Invoke();
if (isValid)
{
// 검증 통과 시 에러 상태 해제
EnableInClassList("utk-integer-field--error", false);
UpdateErrorLabel(null);
}
else
{
// 검증 실패 시 에러 상태 표시
EnableInClassList("utk-integer-field--error", true);
UpdateErrorLabel(_errorMessage);
}
return isValid;
}
private void UpdateErrorLabel(string? message)
{
if (string.IsNullOrEmpty(message))
{
// 에러 라벨 숨기기 (존재하면)
if (_errorLabel != null)
{
_errorLabel.style.display = DisplayStyle.None;
}
return;
}
// 에러 라벨 생성 (지연 생성 - 필요할 때만)
if (_errorLabel == null)
{
_errorLabel = new Label();
_errorLabel.AddToClassList("utk-integer-field__error-message");
_errorLabel.style.display = DisplayStyle.None;
Add(_errorLabel);
}
_errorLabel.text = message;
_errorLabel.style.display = DisplayStyle.Flex;
}
#endregion
#region IDisposable
public void Dispose()
{
if (_disposed) return;
_disposed = true;
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
UnregisterCallback<AttachToPanelEvent>(OnAttachToPanelForTheme);
UnregisterCallback<DetachFromPanelEvent>(OnDetachFromPanelForTheme);
UnregisterCallback<ChangeEvent<int>>(OnFieldValueChanged);
UnregisterCallback<FocusOutEvent>(OnFocusOut);
UnregisterCallback<KeyDownEvent>(OnKeyDown);
OnValueChanged = null;
_validation = null;
_errorLabel = null;
}
#endregion
}
}