swingのJPanelに付けるスクロールバーについて

Question

こんばんは

JPanelにJScrollPaneでスクロールバーを付けてみたのですが、コードとして適切なのかがわかりません。
コンパイルも通るし、実行もできるのですが・・・
腑に落ちない点として２つあります。
１、panel.setPreferredSize
panelにはボタンを座標指定で配置したいのでsetLayoutにnullを指定しています。
でも他の関連サイトを見ていると、setPreferredSizeのメソッドはレイアウトマネージャーが無効の時は普通は使わないという風に書かれていました。なぜダメなのかが分かりませんでした。
また、レイアウトマネージャーが無効でsetPreferredSizeメソッドを使わないでスクロールバーを付けることができませんでした。

２、new Dimension(100, 3000)
Dimensionでサイズをしていしていますが、幅の100は変えても実行結果に変化がありません。自分のプログラムがおかしいのかもしれませんが、そこが少し気持ち悪く感じます。

文章が雑で申し訳ないです。
実際の開発現場でスクロールバーをパネルに付けるとしたら、どのようにコードを書くのかをご教授ください。下記が現在のプログラムコードです。

import javax.swing.*;
import java.awt.CardLayout;
import java.awt.BorderLayout;
import java.awt.event.*;
import java.awt.Color;
import java.awt.Dimension;


public class Page2 extends JFrame{
	public static void main(String [] args){
		Page2 frame = new Page2();
		frame.setLayout(null);
		frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		frame.setBounds(0,0,500,630);
		frame.setTitle("タイトル");
		frame.setVisible(true);
	}
	
	Page2(){
		JPanel panel = new JPanel();
		panel.setLayout(null);
		panel.setPreferredSize(new Dimension(100, 3000));
		JButton button = new JButton("ボタン");
		button.setBounds(0,0,100,100);
		panel.add(button);
		
		JScrollPane  scrollpane = new JScrollPane(); 
		scrollpane.setBounds(0, 0, 510, 400);
		this.getContentPane().add(scrollpane);
		scrollpane.setViewportView(panel);
	}
}

Answer 1

全般的にswingのレイアウトについてかなり混乱しておられる印象です。

前置き(長くてスミマセン)

色々指摘できそうなところがあります。例えばJFrameのレイアウトマネージャーは普通は無効にしません。無効にしたときどうしなければいけないかはっきりコメントできませんが、自分自身で生成したコンポーネントだけでなくJFrameの内部を構成するJLayeredPaneなども含め全てのContainer(それは全てのswingのJComponentと同義)のレイアウトマネージャーをnullにし、全てのコンポーネントのレイアウトを自分自身で制御しないといけないんじゃないかなぁと思います(※)。

しかしJScrollPaneの振る舞いは主としてレイアウトマネージャーScrollPaneLayoutの働きに依存してていますので、そもそも「全てのレイアウトマネージャーをnullにしてしまうことはスクロールの制御もまた自前でやらねばならない」気がします。

panelにはボタンを座標指定で配置したいのでsetLayoutにnullを指定しています。

一般的に何がベストかというのは言いにくいですが、自分はレイアウトマネージャーを無効にするのは極力避けるのがよいと思います。もしnullにするならswingのレイアウト処理への影響がどうなるかを踏まえた上で、レイアウトマネージャーがレイアウトする範囲とアプリケーション自信が(レイアウトマネージャーの助けを借りずに)レイアウトする範囲を明確に区別して実装する必要があると思います。(ことによると)全てをレイアウトマネージャーに任せるよりもっとswingの動作を詳しく知っていないといけないかも知れません。

本件について、panelのレイアウトをnullにしたい理由はわかります。全ての子供のレイアウトを自前で決めたいからですね？

しかしながらこのpanel自身とそれより親の階層にあるコンポーネントのレイアウトはレイアウトマネージャーにまかせたほうがよいでしょう。そうでないと※に書いたことをやる羽目になり、ウィンドウシステム(WindowsなのかMacintoshなのかLinuxの何かのウィンドウマネージャーなのかなど)をガチガチに意識した実装になりかねませんし、いろいろな状況での自前でのレイアウトは大変面倒であると思います。

ご質問について

1(a). setPreferredSizeのメソッドはレイアウトマネージャーが無効の時は普通は使わない

なぜならこのメソッドは、レイアウトマネージャーに対して自身のサイズを「できればこうしてほしい」と宣言するためのものだからです。このメソッドを呼び出したからと言ってサイズは変化しません。レイアウトマネージャーがレイアウト(子供の位置やサイズ)を決めるにあたり「さて、君はどういう大きさにしてほしいんだい？」という意味でgetPreferrdSize()を呼び出します。setPreferredSizeはこの問いへの応答サイズを覚えておくためのメソッドにすぎないのです。
レイアウトマネージャーを無効にするならそのコンテナの子供のサイズは全て自前で計算しsetBoundsなどで設定すべきです。この違いをわかった上でsetBoundsとsetPreferredSize/setMinimumSize/setMaxinumSizeのどちらを使うか考えないと画面の初期化コードはカオスなことになってしまいます。

1(b). レイアウトマネージャーが無効でsetPreferredSizeメソッドを使わないでスクロールバーを付けることができませんでした。

実はJScrollPaneのviewportViewに設定するJPanelのレイアウトマネージャーが無効だとうまくいかないということはありません。原因は別のところにあります。JScrollPaneは垂直スクロールバーを画面上に出そうとはしているのです。しかし

• JScrollPaneの幅が510, それが乗っかっているJFrameの幅が500

矛盾してます。

• JFrameのレイアウトマネージャーが無効

これが適切にレイアウトしてくれれば普通は
JFrameの幅 > contentPaneの幅 >= JScrollPaneの幅 + 垂直スクロールバーの幅
となるようレイアウトマネージャーがよきに計らってくれます。しかしご質問のコードではそれを中途半端に無効にしているため思ったようなサイズにならず、結果としてJScrollPane自身のサイズがおかしくなり期待どおりに表示されなかったのだと思います。

1. viewportViewの幅を100にしているのに実行結果に変化がない

JScrollPaneの仕様みたいです。viewportViewの幅がviewportの幅より小さいと無条件にviewport幅まで広げるみたいですね。こうなる根拠は(正直いうと気にしたことないので)正確にわかりませんが、スクロールバーのサムの位置・大きさやviewportViewの位置の計算などに都合が悪いからなのかなぁと想像します。

実装例

さて、失礼ながら現在のコードはツッコミどころが多いため「ここをこう直せば」といったコメントがしにくいです。ただご質問のコードは本件の話題を議論するのに充分シンプルな内容になっているため、似た画面を出す「こうしたらどうでしょう」といったコード例は書けそうに思いました。

import javax.swing.*;
import java.awt.*;

public class Page2 extends JFrame {
  public static void main(String [] args) {
    new Page2().setVisible(true);
  }
  
  Page2() {
    super("タイトル");
    setDefaultCloseOperation(EXIT_ON_CLOSE);
    
    JPanel panel = new JPanel(null) { // constructorにLayoutManagerを指定できます。
      {  // 匿名クラスの初期化ブロックに書くとメソッドの操作対象を省略できる
        // 親(JViewport)はレイアウトマネージャーを持っているので推奨サイズ制約を設定しておく必要がある。
        // 逆にsetBoundsは意味がない。他も同様の考え方でどちらかを選択。
        setPreferredSize(new Dimension(100, 3000));
      }
    };
    JButton button = new JButton("ボタン") {
      {
        // 親のレイアウトマネージャーが無効なので自前でサイズを設定
        setBounds(5, 5, 100, 100);
      }
    };
    panel.add(button);
    
    JScrollPane scrollPane = new JScrollPane(panel) {
      {
        // 親はレイアウトマネージャーを持っているのでサイズ制約を設定
        setPreferredSize(new Dimension(510, 400));
      }
    };
    
    add(scrollPane, BorderLayout.CENTER); // こう書けばcontentPaneへのaddと解釈してくれる
    // Scrollpaneの下にもう一つ何か置いておきましょう。
    add(new JLabel("JFrameさん私も表示してください"), BorderLayout.SOUTH);
    
    // 全部自前でレイアウトしないかぎりpackは必須。
    // これが書かれてないswingアプリは異端に見えます :-P
    pack();
  }
}

捕捉:
(1) yukkuriさんが指摘しておられる点も踏まえたつもりのコードです。元のコードと大分変ってしまってます。
(2) JFrameのサイズを直接指定するのを好む向きもありますが、(子供コンポーネントのサイズ制約が適切に設定されていさえすれば)特にその必要は感じません。

Comments

[rikaruto]

KSwordOfHasteさん、ご回答ありがとうございます。
frame側は普通はレイアウトマネージャーを無効にしないんですね。
もう一つだけ質問してもよろしいでしょうか。
panelの親はscrollPaneになるんでしょうか、それともJViewportになるんでしょうか。

[KSwordOfHaste]

どちらが親かの意識はそれほど必要ない気がしますがボタンクリックでpanel.getParent()をデバッグプリントしてみれば簡単に確認できると思います。やってみてください。
(正直言えば即答できる自信がないです。かつては覚えていたと思うのですが、swingをかかなくなって久しいため忘れてしまいました orz)

[rikaruto]

panel.getParent()を実行するとjavax.swing.JViewportと表記されたのでJViewportが親になるんですね。
一応panelがscrollPane.getViewport()に含まれているかを調べると"含まれている"が結果として表記されました。

if (panel.getParent() == scrollPane.getViewport()) {
System.out.println("含まれている");
} else {
// 含まれてない
System.out.println("含まれていない");
}

[KSwordOfHaste]

よく見たら自分の回答に「親(JViewport)」と書いてありました。聞かれると自信ないのに回答文を書く途中はよく注意せずに書いてしまったものと思います。失礼しました。

[rikaruto]

いえ、自分の質問内容がわかりにくかったです。すみませんでした！
javaでgui作成って難しいですね。
KSwordOfHasteさんはswingを何かサイトや本を参考に勉強したのでしょうか。もしよろしければ教えていただけないでしょうか。

[KSwordOfHaste]

javaとかswingとは関係なく一般にGUIというのは難しいものです。
swingは何十年前に初めて触れたという感じです。すごいおっさんなのですよ。
当時はネットもあまり発達しておらずとにかくリファレンスを読みふけり、上に書いたような実験を繰り返しだんだんわかってきたという感じでした。今ならもっと情報が豊富なのでそういうのを利用するのがいいと思います。ケチケチせずに(w;)ちょっとぐらい古くていいから本買うのがいいかもです。

[KSwordOfHaste]

余談ですがswingは古いライブラリーというのはご存じですよね？一応JavaFXが最新です。しかしOracleも手を放しちゃったし(JDK11に入ってない)JavaFXやるよりかGUIはJavaScript+HTMLを勉強した方が使う機会が多い気がします。自分はアマチュアなので自分用のスタンドアロンアプリを作る関係上Webにはそれほど興味がないのでswingやJavaFX、PythonなどでGUIを作る機会が多い(多かった)ですがマイナー感を感じております。

[rikaruto]

中古で本を探してみます！
今、javaを勉強していて目標はweb上で動くアプリを作ることなんですけど、まずは自分のPCだけで動くアプリを作ってみたくてswingを勉強しようと思いました。JavaFXがjavaのguiで最新というのは知っていたのですが、swingの方がyoutubeの実況動画があったり、参考サイトが多い気がしてswingにしました。
何か１つswingでアプリを作成できたら、KSwordOfHasteさんがおっしゃるようにJavaScriptやHTMLを勉強したいです。

Answer 2

1.について

でも他の関連サイトを見ていると、setPreferredSizeのメソッドはレイアウトマネージャーが無効の時は普通は使わないという風に書かれていました。

また、レイアウトマネージャーが無効でsetPreferredSizeメソッドを使わないでスクロールバーを付けることができませんでした。

パネルのことならレイアウトをnullにする前に実行すればいいのでは？
また、なぜスクロールバーをつけられない、という考えになるのかわかりません。

その関連サイトがわかりませんが、この理由は正直私にもわかりません。

2.について
気になったのは、

scrollpane.setViewportView(panel);

ですかね。
普通に

JScrollPane scrollpane = new JScrollPane( スクロールバーに入れたいパネルなど );

でいいと思うんですけど... どうなんでしょうか？

また、コードとして適切か、と言われると、悪い方な気がします。
基本、mainメゾッドでインスタンスの設定をしない気がします。
コンストラクタでまとめてして、そのインスタンスを使わないのなら呼び出すだけ、
使うのなら変数で保存ですかね。

class Hoge
{
  public static void main( String[] args )
  {
    new Hoge();   // インスタンスを使わないなら
//  Hoge hoge = new Hoge();  インスタンスを使うなら
  }

  Hoge()
  {
  }
}

実行結果とは関係ないけど

this.getContentPane()...

のthis.と

frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

のJFrame.は自分自身なので要りません。

Comments

[rikaruto]

yukkuriさん、回答ありがとうございます。
panel.setPreferredSize(new Dimension(100, 3000));
panel.setLayout(null);
という順番にしてみました。

でもちょっとわからない所があります。
Dimensionでサイズを指定していますが、幅の100という部分は適用されないのでしょうか？
それとも、
JScrollPane scrollpane = new JScrollPane();
scrollpane.setBounds(0, 0, 510, 400);
での510という幅で適用されているのでしょうか。

[yukkuri]

後者だと思います。横幅を800とかにして試してはどうでしょうか。
> 幅の100という部分は適用されない
横向きのスライドバーが出てこない、という話であればこちらのサイトが参考になります。
https://www.javadrive.jp/tutorial/jscrollpane/index3.html

[KSwordOfHaste]

「また、コードとして適切か」以降のアドバイスはとても有用だと思いました。ただ特に1の内容は勘違いされてるようでしたので自分の回答1(a)にて少し詳しく述べてみました。

2や一部のレイアウトマネージャーを無効にする前提の話など自分にも難しくreshapeメソッドをoverrideして「誰がいつサイズを設定しているか」をスタックトレースで調べたりしました。非常に泥臭い調べ方ですけどレイアウトは難しいトピックなのでそんな泥臭さも時に手っ取り早く原因を知るには約に立つことがあると思います。

[yukkuri]

私の知識不足で間違えた情報を書いていたようですね。申し訳ありません。